@fluidframework/tree 2.50.0 → 2.51.0-347100

package/dist/shared-tree/checkoutFlexTreeView.d.ts

@@ -1,58 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { Context, type FlexTreeField, type NodeIdentifierManager, type FlexTreeHydratedContext, type FullSchemaPolicy } from "../feature-libraries/index.js";
-import { disposeSymbol } from "../util/index.js";
-import type { ITreeCheckout, ITreeCheckoutFork } from "./treeCheckout.js";
-/**
- * An editable view of a (version control style) branch of a shared tree.
- * @remarks
- * Does not depend on stored schema, and thus can live across schema changes.
- * @privateRemarks
- * This has no state beyond the context, so it likely should be replaced with just the context.
- */
-export declare class CheckoutFlexTreeView<out TCheckout extends ITreeCheckout = ITreeCheckout> {
-    /**
-     * Access non-view schema specific aspects of this branch.
-     *
-     * @remarks
-     * This is a non-owning reference: disposing of this view does not impact the branch.
-     */
-    readonly checkout: TCheckout;
-    readonly schema: FullSchemaPolicy;
-    readonly nodeKeyManager: NodeIdentifierManager;
-    private readonly onDispose?;
-    /**
-     * Context for controlling the FlexTree nodes produced from {@link FlexTreeView.flexTree}.
-     *
-     * @remarks
-     * This is an owning reference: disposing of this view disposes its context.
-     */
-    readonly context: Context;
-    /**
-     * Get a view of the tree content using the flex-tree API.
-     */
-    get flexTree(): FlexTreeField;
-    private disposed;
-    constructor(
-    /**
-     * Access non-view schema specific aspects of this branch.
-     *
-     * @remarks
-     * This is a non-owning reference: disposing of this view does not impact the branch.
-     */
-    checkout: TCheckout, schema: FullSchemaPolicy, nodeKeyManager: NodeIdentifierManager, onDispose?: (() => void) | undefined);
-    [disposeSymbol](): void;
-    /**
-     * Spawn a new view which is based off of the current state of this view.
-     * Any mutations of the new view will not apply to this view until the new view is merged back into this view via `merge()`.
-     */
-    fork(): CheckoutFlexTreeView<ITreeCheckout & ITreeCheckoutFork>;
-}
-/**
- * Retrieve the {@link CheckoutFlexTreeView | view} for the given {@link FlexTreeHydratedContext | context}.
- * @remarks Every {@link CheckoutFlexTreeView} is associated with its context upon creation.
- */
-export declare function getCheckoutFlexTreeView(context: FlexTreeHydratedContext): CheckoutFlexTreeView;
-//# sourceMappingURL=checkoutFlexTreeView.d.ts.map

package/dist/shared-tree/checkoutFlexTreeView.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkoutFlexTreeView.d.ts","sourceRoot":"","sources":["../../src/shared-tree/checkoutFlexTreeView.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,OAAO,EACP,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAE1E;;;;;;GAMG;AACH,qBAAa,oBAAoB,CAAC,GAAG,CAAC,SAAS,SAAS,aAAa,GAAG,aAAa;IAmBnF;;;;;OAKG;aACa,QAAQ,EAAE,SAAS;aACnB,MAAM,EAAE,gBAAgB;aACxB,cAAc,EAAE,qBAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IA3B5B;;;;;OAKG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAEnC;IAED,OAAO,CAAC,QAAQ,CAAS;;IAGxB;;;;;OAKG;IACa,QAAQ,EAAE,SAAS,EACnB,MAAM,EAAE,gBAAgB,EACxB,cAAc,EAAE,qBAAqB,EACpC,SAAS,CAAC,SAAQ,IAAI,aAAA;IAMjC,CAAC,aAAa,CAAC,IAAI,IAAI;IAY9B;;;OAGG;IACI,IAAI,IAAI,oBAAoB,CAAC,aAAa,GAAG,iBAAiB,CAAC;CAKtE;AAQD;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,OAAO,EAAE,uBAAuB,GAC9B,oBAAoB,CAItB"}

package/dist/shared-tree/checkoutFlexTreeView.js

@@ -1,77 +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.getCheckoutFlexTreeView = exports.CheckoutFlexTreeView = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const index_js_1 = require("../feature-libraries/index.js");
-const index_js_2 = require("../simple-tree/index.js");
-const index_js_3 = require("../util/index.js");
-/**
- * An editable view of a (version control style) branch of a shared tree.
- * @remarks
- * Does not depend on stored schema, and thus can live across schema changes.
- * @privateRemarks
- * This has no state beyond the context, so it likely should be replaced with just the context.
- */
-class CheckoutFlexTreeView {
-    /**
-     * Get a view of the tree content using the flex-tree API.
-     */
-    get flexTree() {
-        return this.context.root;
-    }
-    constructor(
-    /**
-     * Access non-view schema specific aspects of this branch.
-     *
-     * @remarks
-     * This is a non-owning reference: disposing of this view does not impact the branch.
-     */
-    checkout, schema, nodeKeyManager, onDispose) {
-        this.checkout = checkout;
-        this.schema = schema;
-        this.nodeKeyManager = nodeKeyManager;
-        this.onDispose = onDispose;
-        this.disposed = false;
-        this.context = new index_js_1.Context(schema, this.checkout, nodeKeyManager);
-        contextToTreeViewMap.set(this.context, this);
-    }
-    [index_js_3.disposeSymbol]() {
-        (0, internal_1.assert)(!this.disposed, 0xb80 /* Double disposed */);
-        this.disposed = true;
-        for (const anchorNode of this.checkout.forest.anchors) {
-            (0, index_js_2.tryDisposeTreeNode)(anchorNode);
-        }
-        this.context[index_js_3.disposeSymbol]();
-        this.onDispose?.();
-    }
-    /**
-     * Spawn a new view which is based off of the current state of this view.
-     * Any mutations of the new view will not apply to this view until the new view is merged back into this view via `merge()`.
-     */
-    fork() {
-        (0, internal_1.assert)(!this.disposed, 0xb81 /* disposed */);
-        const branch = this.checkout.branch();
-        return new CheckoutFlexTreeView(branch, this.schema, this.nodeKeyManager);
-    }
-}
-exports.CheckoutFlexTreeView = CheckoutFlexTreeView;
-/**
- * Maps the context of every {@link CheckoutFlexTreeView} to the view.
- * In practice, this allows the view or checkout to be obtained from a flex node by first getting the context from the flex node and then using this map.
- */
-const contextToTreeViewMap = new WeakMap();
-/**
- * Retrieve the {@link CheckoutFlexTreeView | view} for the given {@link FlexTreeHydratedContext | context}.
- * @remarks Every {@link CheckoutFlexTreeView} is associated with its context upon creation.
- */
-function getCheckoutFlexTreeView(context) {
-    const view = contextToTreeViewMap.get(context);
-    (0, internal_1.assert)(view !== undefined, 0xa41 /* Expected view to be registered for context */);
-    return view;
-}
-exports.getCheckoutFlexTreeView = getCheckoutFlexTreeView;
-//# sourceMappingURL=checkoutFlexTreeView.js.map

package/dist/shared-tree/checkoutFlexTreeView.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkoutFlexTreeView.js","sourceRoot":"","sources":["../../src/shared-tree/checkoutFlexTreeView.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,4DAMuC;AACvC,sDAA6D;AAC7D,+CAAiD;AAIjD;;;;;;GAMG;AACH,MAAa,oBAAoB;IAShC;;OAEG;IACH,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IAID;IACC;;;;;OAKG;IACa,QAAmB,EACnB,MAAwB,EACxB,cAAqC,EACpC,SAAsB;QAHvB,aAAQ,GAAR,QAAQ,CAAW;QACnB,WAAM,GAAN,MAAM,CAAkB;QACxB,mBAAc,GAAd,cAAc,CAAuB;QACpC,cAAS,GAAT,SAAS,CAAa;QAZhC,aAAQ,GAAG,KAAK,CAAC;QAcxB,IAAI,CAAC,OAAO,GAAG,IAAI,kBAAO,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAClE,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEM,CAAC,wBAAa,CAAC;QACrB,IAAA,iBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvD,IAAA,6BAAkB,EAAC,UAAU,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,wBAAa,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACI,IAAI;QACV,IAAA,iBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO,IAAI,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3E,CAAC;CACD;AAvDD,oDAuDC;AAED;;;GAGG;AACH,MAAM,oBAAoB,GAAG,IAAI,OAAO,EAAiD,CAAC;AAE1F;;;GAGG;AACH,SAAgB,uBAAuB,CACtC,OAAgC;IAEhC,MAAM,IAAI,GAAG,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/C,IAAA,iBAAM,EAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACnF,OAAO,IAAI,CAAC;AACb,CAAC;AAND,0DAMC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport {\n\tContext,\n\ttype FlexTreeField,\n\ttype NodeIdentifierManager,\n\ttype FlexTreeHydratedContext,\n\ttype FullSchemaPolicy,\n} from \"../feature-libraries/index.js\";\nimport { tryDisposeTreeNode } from \"../simple-tree/index.js\";\nimport { disposeSymbol } from \"../util/index.js\";\n\nimport type { ITreeCheckout, ITreeCheckoutFork } from \"./treeCheckout.js\";\n\n/**\n * An editable view of a (version control style) branch of a shared tree.\n * @remarks\n * Does not depend on stored schema, and thus can live across schema changes.\n * @privateRemarks\n * This has no state beyond the context, so it likely should be replaced with just the context.\n */\nexport class CheckoutFlexTreeView<out TCheckout extends ITreeCheckout = ITreeCheckout> {\n\t/**\n\t * Context for controlling the FlexTree nodes produced from {@link FlexTreeView.flexTree}.\n\t *\n\t * @remarks\n\t * This is an owning reference: disposing of this view disposes its context.\n\t */\n\tpublic readonly context: Context;\n\n\t/**\n\t * Get a view of the tree content using the flex-tree API.\n\t */\n\tpublic get flexTree(): FlexTreeField {\n\t\treturn this.context.root;\n\t}\n\n\tprivate disposed = false;\n\n\tpublic constructor(\n\t\t/**\n\t\t * Access non-view schema specific aspects of this branch.\n\t\t *\n\t\t * @remarks\n\t\t * This is a non-owning reference: disposing of this view does not impact the branch.\n\t\t */\n\t\tpublic readonly checkout: TCheckout,\n\t\tpublic readonly schema: FullSchemaPolicy,\n\t\tpublic readonly nodeKeyManager: NodeIdentifierManager,\n\t\tprivate readonly onDispose?: () => void,\n\t) {\n\t\tthis.context = new Context(schema, this.checkout, nodeKeyManager);\n\t\tcontextToTreeViewMap.set(this.context, this);\n\t}\n\n\tpublic [disposeSymbol](): void {\n\t\tassert(!this.disposed, 0xb80 /* Double disposed */);\n\t\tthis.disposed = true;\n\n\t\tfor (const anchorNode of this.checkout.forest.anchors) {\n\t\t\ttryDisposeTreeNode(anchorNode);\n\t\t}\n\n\t\tthis.context[disposeSymbol]();\n\t\tthis.onDispose?.();\n\t}\n\n\t/**\n\t * Spawn a new view which is based off of the current state of this view.\n\t * Any mutations of the new view will not apply to this view until the new view is merged back into this view via `merge()`.\n\t */\n\tpublic fork(): CheckoutFlexTreeView<ITreeCheckout & ITreeCheckoutFork> {\n\t\tassert(!this.disposed, 0xb81 /* disposed */);\n\t\tconst branch = this.checkout.branch();\n\t\treturn new CheckoutFlexTreeView(branch, this.schema, this.nodeKeyManager);\n\t}\n}\n\n/**\n * Maps the context of every {@link CheckoutFlexTreeView} to the view.\n * In practice, this allows the view or checkout to be obtained from a flex node by first getting the context from the flex node and then using this map.\n */\nconst contextToTreeViewMap = new WeakMap<FlexTreeHydratedContext, CheckoutFlexTreeView>();\n\n/**\n * Retrieve the {@link CheckoutFlexTreeView | view} for the given {@link FlexTreeHydratedContext | context}.\n * @remarks Every {@link CheckoutFlexTreeView} is associated with its context upon creation.\n */\nexport function getCheckoutFlexTreeView(\n\tcontext: FlexTreeHydratedContext,\n): CheckoutFlexTreeView {\n\tconst view = contextToTreeViewMap.get(context);\n\tassert(view !== undefined, 0xa41 /* Expected view to be registered for context */);\n\treturn view;\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"flexList.d.ts","sourceRoot":"","sources":["../../src/simple-tree/flexList.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAaH,gFAAgF;AAChF,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,MAAM,IAAI,CAErE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CASpC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,GAAG,OAAO,IAAI,SAAS,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;AAEjE;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,IAAI,GAAG,OAAO,IAAI,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,QAAQ,IAAI,IAAI,SAAS,MAAM,MAAM,MAAM,GACjF,MAAM,GACN,IAAI,CAAC;AAER;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,QAAQ,IAAI,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"flexList.js","sourceRoot":"","sources":["../../src/simple-tree/flexList.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAAiD;AACjD,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAU/C,gFAAgF;AAChF,SAAgB,MAAM,CAAO,IAAoB;IAChD,OAAO,OAAO,IAAI,KAAK,UAAU,IAAK,IAA6B,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC;AAC7F,CAAC;AAFD,wBAEC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAI,CAAI;IAChC,OAAO,MAAM,CAAC,CAAC,CAAC;QACf,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,aAAa,EAAE;YACxC,KAAK,EAAE,IAAI;YACX,YAAY,EAAE,IAAI;YAClB,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;SACf,CAAC;QACH,CAAC,CAAC,CAAC,CAAC;AACN,CAAC;AATD,8BASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/** A symbol used to identify a `MarkedEager`. */\nconst flexListEager = Symbol(\"FlexList Eager\");\n\n/**\n * An object that has been marked as eager (as opposed to lazy) when used as an item in a `FlexList`.\n * It will be considered to be an eager item in a `FlexList` even if it is a function.\n */\ninterface MarkedEager {\n\t[flexListEager]: true;\n}\n\n/** Returns true iff the given item is a function and is not a `MarkedEager`. */\nexport function isLazy<Item>(item: LazyItem<Item>): item is () => Item {\n\treturn typeof item === \"function\" && (item as Partial<MarkedEager>)[flexListEager] !== true;\n}\n\n/**\n * Mark the given object as an eager item in a `FlexList`.\n * @remarks\n * This only has an effect on function objects that would otherwise be considered to be lazy items in a `FlexList`.\n * @param t - The object to mark as eager.\n * @returns `t`, marked as eager if applicable.\n */\nexport function markEager<T>(t: T): T {\n\treturn isLazy(t)\n\t\t? Object.defineProperty(t, flexListEager, {\n\t\t\t\tvalue: true,\n\t\t\t\tconfigurable: true,\n\t\t\t\tenumerable: false,\n\t\t\t\twritable: false,\n\t\t\t})\n\t\t: t;\n}\n\n/**\n * A flexible way to list values.\n * Each item in the list can either be an \"eager\" **value** or a \"lazy\" **function that returns a value** (the latter allows cyclic references to work).\n * @privateRemarks\n * By default, items that are of type `\"function\"` will be considered lazy and all other items will be considered eager.\n * To force a `\"function\"` item to be treated as an eager item, call `markEager` before putting it in the list.\n * This is necessary e.g. when the eager list items are function types and the lazy items are functions that _return_ function types.\n * Our one use of FlexList has some special normalization logic, see {@link normalizeAllowedTypes}.\n * @system @public\n */\nexport type FlexList<Item = unknown> = readonly LazyItem<Item>[];\n\n/**\n * An \"eager\" or \"lazy\" Item in a `FlexList`.\n * Lazy items are wrapped in a function to allow referring to themselves before they are declared.\n * This makes recursive and co-recursive items possible.\n * @privateRemarks\n * `schemaTypes.ts`'s `evaluateLazySchema` (via {@link normalizeAllowedTypes})\n * applies caching for the only current use of this type.\n * @public\n */\nexport type LazyItem<Item = unknown> = Item | (() => Item);\n\n/**\n * Get the `Item` type from a `LazyItem<Item>`.\n * @system @public\n */\nexport type ExtractItemType<Item extends LazyItem> = Item extends () => infer Result\n\t? Result\n\t: Item;\n\n/**\n * Normalize FlexList type to a union.\n * @system @public\n */\nexport type FlexListToUnion<TList extends FlexList> = ExtractItemType<TList[number]>;\n"]}