@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

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

@@ -0,0 +1,243 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TreeValue } from "../core";
+import { RestrictiveReadonlyRecord } from "../util";
+import { FieldKind, FieldKinds, AllowedTypes, Any, FieldNodeSchema, TreeFieldSchema, InternalTypedSchemaTypes, LeafNodeSchema, MapNodeSchema, ObjectNodeSchema, TreeNodeSchema, AssignableFieldKinds } from "../feature-libraries";
+import { IterableTreeListContent, TreeListNodeOld } from "./treeListNode";
+/**
+ * Type alias to document which values are un-hydrated.
+ *
+ * Un-hydrated values are nodes produced from schema's create functions that haven't been inserted into a tree yet.
+ *
+ * Since un-hydrated nodes become hydrated when inserted, strong typing can't be used to distinguish them.
+ * This no-op wrapper is used instead.
+ * @beta
+ */
+export type Unhydrated<T> = T;
+/**
+ * A non-{@link LeafNodeSchema|leaf} SharedTree node. Includes objects, lists, and maps.
+ *
+ * @remarks
+ * Base type which all nodes extend.
+ * @privateRemarks
+ * Adding a member which all nodes have, like a type symbol, would produce much strong typing for this.
+ * @beta
+ */
+export declare class TreeNode {
+}
+/**
+ * A generic List type, used to defined types like {@link (TreeArrayNode:interface)}.
+ * @beta
+ */
+export interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom> extends ReadonlyArray<T> {
+    /**
+     * Inserts new item(s) at a specified location.
+     * @param index - The index at which to insert `value`.
+     * @param value - The content to insert.
+     * @throws Throws if `index` is not in the range [0, `list.length`).
+     */
+    insertAt(index: number, ...value: (TNew | IterableTreeListContent<TNew>)[]): void;
+    /**
+     * Inserts new item(s) at the start of the list.
+     * @param value - The content to insert.
+     */
+    insertAtStart(...value: (TNew | IterableTreeListContent<TNew>)[]): void;
+    /**
+     * Inserts new item(s) at the end of the list.
+     * @param value - The content to insert.
+     */
+    insertAtEnd(...value: (TNew | IterableTreeListContent<TNew>)[]): void;
+    /**
+     * Removes the item at the specified location.
+     * @param index - The index at which to remove the item.
+     * @throws Throws if `index` is not in the range [0, `list.length`).
+     */
+    removeAt(index: number): void;
+    /**
+     * Removes all items between the specified indices.
+     * @param start - The starting index of the range to remove (inclusive). Defaults to the start of the list.
+     * @param end - The ending index of the range to remove (exclusive).
+     * @throws Throws if `start` is not in the range [0, `list.length`).
+     * @throws Throws if `end` is less than `start`.
+     * If `end` is not supplied or is greater than the length of the list, all items after `start` are deleted.
+     */
+    removeRange(start?: number, end?: number): void;
+    /**
+     * Moves the specified item to the start of the list.
+     * @param sourceIndex - The index of the item to move.
+     * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).
+     */
+    moveToStart(sourceIndex: number): void;
+    /**
+     * Moves the specified item to the start of the list.
+     * @param sourceIndex - The index of the item to move.
+     * @param source - The source list to move the item out of.
+     * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).
+     */
+    moveToStart(sourceIndex: number, source: TMoveFrom): void;
+    /**
+     * Moves the specified item to the end of the list.
+     * @param sourceIndex - The index of the item to move.
+     * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).
+     */
+    moveToEnd(sourceIndex: number): void;
+    /**
+     * Moves the specified item to the end of the list.
+     * @param sourceIndex - The index of the item to move.
+     * @param source - The source list to move the item out of.
+     * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).
+     */
+    moveToEnd(sourceIndex: number, source: TMoveFrom): void;
+    /**
+     * Moves the specified item to the desired location in the list.
+     * @param index - The index to move the item to.
+     * This is based on the state of the list before moving the source item.
+     * @param sourceIndex - The index of the item to move.
+     * @throws Throws if any of the input indices are not in the range [0, `list.length`).
+     */
+    moveToIndex(index: number, sourceIndex: number): void;
+    /**
+     * Moves the specified item to the desired location in the list.
+     * @param index - The index to move the item to.
+     * @param sourceIndex - The index of the item to move.
+     * @param source - The source list to move the item out of.
+     * @throws Throws if any of the input indices are not in the range [0, `list.length`).
+     */
+    moveToIndex(index: number, sourceIndex: number, source: TMoveFrom): void;
+    /**
+     * Moves the specified items to the start of the list.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @throws Throws if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToStart(sourceStart: number, sourceEnd: number): void;
+    /**
+     * Moves the specified items to the start of the list.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @param source - The source list to move items out of.
+     * @throws Throws if the types of any of the items being moved are not allowed in the destination list,
+     * if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToStart(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
+    /**
+     * Moves the specified items to the end of the list.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @throws Throws if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToEnd(sourceStart: number, sourceEnd: number): void;
+    /**
+     * Moves the specified items to the end of the list.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @param source - The source list to move items out of.
+     * @throws Throws if the types of any of the items being moved are not allowed in the destination list,
+     * if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToEnd(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
+    /**
+     * Moves the specified items to the desired location within the list.
+     * @param index - The index to move the items to.
+     * This is based on the state of the list before moving the source items.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @throws Throws if any of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToIndex(index: number, sourceStart: number, sourceEnd: number): void;
+    /**
+     * Moves the specified items to the desired location within the list.
+     * @param index - The index to move the items to.
+     * @param sourceStart - The starting index of the range to move (inclusive).
+     * @param sourceEnd - The ending index of the range to move (exclusive)
+     * @param source - The source list to move items out of.
+     * @throws Throws if the types of any of the items being moved are not allowed in the destination list,
+     * if any of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.
+     */
+    moveRangeToIndex(index: number, sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
+}
+/**
+ * An object which supports property-based access to fields.
+ */
+export type TreeObjectNode<TSchema extends ObjectNodeSchema> = TreeObjectNodeFields<TSchema["objectNodeFieldsObject"]>;
+/**
+ * Helper for generating the properties of a {@link TreeObjectNode}.
+ * @privateRemarks
+ * This type is composed of four subtypes for each mutually exclusive combination of "readonly" and "optional".
+ * If it were possible to map to getters and setters separately, the "readonly" cases would collapse, but this is not currently a feature in TS.
+ * See https://github.com/microsoft/TypeScript/issues/43826 for more details on this limitation.
+ */
+export type TreeObjectNodeFields<TFields extends RestrictiveReadonlyRecord<string, TreeFieldSchema>> = {
+    -readonly [key in keyof TFields as TFields[key]["kind"] extends AssignableFieldKinds ? TFields[key]["kind"] extends typeof FieldKinds.optional ? key : never : never]?: TreeField<TFields[key]>;
+} & {
+    -readonly [key in keyof TFields as TFields[key]["kind"] extends AssignableFieldKinds ? TFields[key]["kind"] extends typeof FieldKinds.optional ? never : key : never]-?: TreeField<TFields[key]>;
+} & {
+    readonly [key in keyof TFields as TFields[key]["kind"] extends AssignableFieldKinds ? never : TFields[key]["kind"] extends typeof FieldKinds.optional ? key : never]?: TreeField<TFields[key]>;
+} & {
+    readonly [key in keyof TFields as TFields[key]["kind"] extends AssignableFieldKinds ? never : TFields[key]["kind"] extends typeof FieldKinds.optional ? never : key]-?: TreeField<TFields[key]>;
+};
+/**
+ * A map of string keys to tree objects.
+ *
+ * @privateRemarks
+ * Add support for `clear` once we have established merge semantics for it.
+ *
+ */
+export interface TreeMapNode<TSchema extends MapNodeSchema = MapNodeSchema> extends TreeMapNodeBase<TreeField<TSchema["info"], "notEmpty">> {
+}
+/**
+ * A map of string keys to tree objects.
+ *
+ * @privateRemarks
+ * Add support for `clear` once we have established merge semantics for it.
+ *
+ * @beta
+ */
+export interface TreeMapNodeBase<TOut, TIn = TOut> extends ReadonlyMap<string, TOut> {
+    /**
+     * Adds or updates an entry in the map with a specified `key` and a `value`.
+     *
+     * @param key - The key of the element to add to the map.
+     * @param value - The value of the element to add to the map.
+     *
+     * @remarks
+     * Setting the value at a key to `undefined` is equivalent to calling {@link TreeMapNodeBase.delete} with that key.
+     */
+    set(key: string, value: TIn | undefined): void;
+    /**
+     * Removes the specified element from this map by its `key`.
+     *
+     * @remarks
+     * Note: unlike JavaScript's Map API, this method does not return a flag indicating whether or not the value was
+     * deleted.
+     *
+     * @privateRemarks
+     * Regarding the choice to not return a boolean: Since this data structure is distributed in nature, it isn't
+     * possible to tell whether or not the item was deleted as a result of this method call. Returning a "best guess"
+     * is more likely to create issues / promote bad usage patterns than offer useful information.
+     *
+     * @param key - The key of the element to remove from the map.
+     */
+    delete(key: string): void;
+}
+/**
+ * Given a field's schema, return the corresponding object in the proxy-based API.
+ */
+export type TreeField<TSchema extends TreeFieldSchema = TreeFieldSchema, Emptiness extends "maybeEmpty" | "notEmpty" = "maybeEmpty"> = TreeFieldInner<TSchema["kind"], TSchema["allowedTypes"], Emptiness>;
+/**
+ * Helper for implementing {@link TreeField}.
+ */
+export type TreeFieldInner<Kind extends FieldKind, TTypes extends AllowedTypes, Emptiness extends "maybeEmpty" | "notEmpty"> = Kind extends typeof FieldKinds.sequence ? never : Kind extends typeof FieldKinds.required ? TreeNodeUnion<TTypes> : Kind extends typeof FieldKinds.optional ? TreeNodeUnion<TTypes> | (Emptiness extends "notEmpty" ? never : undefined) : unknown;
+/**
+ * Given multiple node schema types, return the corresponding object type union in the proxy-based API.
+ */
+export type TreeNodeUnion<TTypes extends AllowedTypes> = TTypes extends readonly [Any] ? unknown : {
+    [Index in keyof TTypes]: TTypes[Index] extends InternalTypedSchemaTypes.LazyItem<infer InnerType> ? InnerType extends TreeNodeSchema ? TypedNode<InnerType> : never : never;
+}[number];
+/**
+ * Given a node's schema, return the corresponding object in the proxy-based API.
+ */
+export type TypedNode<TSchema extends TreeNodeSchema> = TSchema extends LeafNodeSchema ? TreeValue<TSchema["info"]> : TSchema extends MapNodeSchema ? TreeMapNode<TSchema> : TSchema extends FieldNodeSchema ? TreeListNodeOld<TSchema["info"]["allowedTypes"]> : TSchema extends ObjectNodeSchema ? TreeObjectNode<TSchema> : TreeNode;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/simple-tree/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EACN,SAAS,EACT,UAAU,EACV,YAAY,EACZ,GAAG,EACH,eAAe,EACf,eAAe,EACf,wBAAwB,EACxB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC;AAE9B;;;;;;;;GAQG;AAEH,qBAAa,QAAQ;CAAG;AAExB;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IACxF;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;IAElF;;;OAGG;IACH,aAAa,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;IAExE;;;OAGG;IACH,WAAW,CAAC,GAAG,KAAK,EAAE,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;IAEtE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhD;;;;OAIG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;;OAKG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAExD;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtD;;;;;;OAMG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEzE;;;;;OAKG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/D;;;;;;;OAOG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAElF;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEhF;;;;;;;OAOG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9E;;;;;;;;OAQG;IACH,gBAAgB,CACf,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,SAAS,GACf,IAAI,CAAC;CACR;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,gBAAgB,IAAI,oBAAoB,CAClF,OAAO,CAAC,wBAAwB,CAAC,CACjC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAC/B,OAAO,SAAS,yBAAyB,CAAC,MAAM,EAAE,eAAe,CAAC,IAC/D;IAEH,CAAC,UAAU,GAAG,IAAI,MAAM,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,oBAAoB,GACjF,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,UAAU,CAAC,QAAQ,GACtD,GAAG,GACH,KAAK,GACN,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CACnC,GAAG;IAEH,CAAC,UAAU,GAAG,IAAI,MAAM,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,oBAAoB,GACjF,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,UAAU,CAAC,QAAQ,GACtD,KAAK,GACL,GAAG,GACJ,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CACpC,GAAG;IAEH,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,oBAAoB,GAChF,KAAK,GACL,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvD,GAAG,GACH,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CACnC,GAAG;IAEH,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,oBAAoB,GAChF,KAAK,GACL,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvD,KAAK,GACL,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,aAAa,GAAG,aAAa,CACzE,SAAQ,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;CAAG;AAEnE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAE,SAAQ,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC;IACnF;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC;IAE/C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CACpB,OAAO,SAAS,eAAe,GAAG,eAAe,EAEjD,SAAS,SAAS,YAAY,GAAG,UAAU,GAAG,YAAY,IACvD,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,cAAc,CACzB,IAAI,SAAS,SAAS,EACtB,MAAM,SAAS,YAAY,EAC3B,SAAS,SAAS,YAAY,GAAG,UAAU,IACxC,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACxC,KAAK,GACL,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvC,aAAa,CAAC,MAAM,CAAC,GACrB,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,SAAS,UAAU,GAAG,KAAK,GAAG,SAAS,CAAC,GAC1E,OAAO,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,MAAM,SAAS,YAAY,IAAI,MAAM,SAAS,SAAS,CAAC,GAAG,CAAC,GACnF,OAAO,GACP;KAIC,KAAK,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,wBAAwB,CAAC,QAAQ,CAC/E,MAAM,SAAS,CACf,GACE,SAAS,SAAS,cAAc,GAC/B,SAAS,CAAC,SAAS,CAAC,GACpB,KAAK,GACN,KAAK;CACP,CAAC,MAAM,CAAC,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,cAAc,IAAI,OAAO,SAAS,cAAc,GACnF,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAC1B,OAAO,SAAS,aAAa,GAC7B,WAAW,CAAC,OAAO,CAAC,GACpB,OAAO,SAAS,eAAe,GAC/B,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,GAChD,OAAO,SAAS,gBAAgB,GAChC,cAAc,CAAC,OAAO,CAAC,GACvB,QAAQ,CAAC"}

package/dist/simple-tree/types.js

@@ -0,0 +1,21 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeNode = void 0;
+/**
+ * A non-{@link LeafNodeSchema|leaf} SharedTree node. Includes objects, lists, and maps.
+ *
+ * @remarks
+ * Base type which all nodes extend.
+ * @privateRemarks
+ * Adding a member which all nodes have, like a type symbol, would produce much strong typing for this.
+ * @beta
+ */
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+class TreeNode {
+}
+exports.TreeNode = TreeNode;
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/simple-tree/types.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA+BH;;;;;;;;GAQG;AACH,kEAAkE;AAClE,MAAa,QAAQ;CAAG;AAAxB,4BAAwB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TreeValue } from \"../core\";\nimport { RestrictiveReadonlyRecord } from \"../util\";\nimport {\n\tFieldKind,\n\tFieldKinds,\n\tAllowedTypes,\n\tAny,\n\tFieldNodeSchema,\n\tTreeFieldSchema,\n\tInternalTypedSchemaTypes,\n\tLeafNodeSchema,\n\tMapNodeSchema,\n\tObjectNodeSchema,\n\tTreeNodeSchema,\n\tAssignableFieldKinds,\n} from \"../feature-libraries\";\nimport { IterableTreeListContent, TreeListNodeOld } from \"./treeListNode\";\n\n/**\n * Type alias to document which values are un-hydrated.\n *\n * Un-hydrated values are nodes produced from schema's create functions that haven't been inserted into a tree yet.\n *\n * Since un-hydrated nodes become hydrated when inserted, strong typing can't be used to distinguish them.\n * This no-op wrapper is used instead.\n * @beta\n */\nexport type Unhydrated<T> = T;\n\n/**\n * A non-{@link LeafNodeSchema|leaf} SharedTree node. Includes objects, lists, and maps.\n *\n * @remarks\n * Base type which all nodes extend.\n * @privateRemarks\n * Adding a member which all nodes have, like a type symbol, would produce much strong typing for this.\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/no-extraneous-class\nexport class TreeNode {}\n\n/**\n * A generic List type, used to defined types like {@link (TreeArrayNode:interface)}.\n * @beta\n */\nexport interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom> extends ReadonlyArray<T> {\n\t/**\n\t * Inserts new item(s) at a specified location.\n\t * @param index - The index at which to insert `value`.\n\t * @param value - The content to insert.\n\t * @throws Throws if `index` is not in the range [0, `list.length`).\n\t */\n\tinsertAt(index: number, ...value: (TNew | IterableTreeListContent<TNew>)[]): void;\n\n\t/**\n\t * Inserts new item(s) at the start of the list.\n\t * @param value - The content to insert.\n\t */\n\tinsertAtStart(...value: (TNew | IterableTreeListContent<TNew>)[]): void;\n\n\t/**\n\t * Inserts new item(s) at the end of the list.\n\t * @param value - The content to insert.\n\t */\n\tinsertAtEnd(...value: (TNew | IterableTreeListContent<TNew>)[]): void;\n\n\t/**\n\t * Removes the item at the specified location.\n\t * @param index - The index at which to remove the item.\n\t * @throws Throws if `index` is not in the range [0, `list.length`).\n\t */\n\tremoveAt(index: number): void;\n\n\t/**\n\t * Removes all items between the specified indices.\n\t * @param start - The starting index of the range to remove (inclusive). Defaults to the start of the list.\n\t * @param end - The ending index of the range to remove (exclusive).\n\t * @throws Throws if `start` is not in the range [0, `list.length`).\n\t * @throws Throws if `end` is less than `start`.\n\t * If `end` is not supplied or is greater than the length of the list, all items after `start` are deleted.\n\t */\n\tremoveRange(start?: number, end?: number): void;\n\n\t/**\n\t * Moves the specified item to the start of the list.\n\t * @param sourceIndex - The index of the item to move.\n\t * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).\n\t */\n\tmoveToStart(sourceIndex: number): void;\n\n\t/**\n\t * Moves the specified item to the start of the list.\n\t * @param sourceIndex - The index of the item to move.\n\t * @param source - The source list to move the item out of.\n\t * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).\n\t */\n\tmoveToStart(sourceIndex: number, source: TMoveFrom): void;\n\n\t/**\n\t * Moves the specified item to the end of the list.\n\t * @param sourceIndex - The index of the item to move.\n\t * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).\n\t */\n\tmoveToEnd(sourceIndex: number): void;\n\n\t/**\n\t * Moves the specified item to the end of the list.\n\t * @param sourceIndex - The index of the item to move.\n\t * @param source - The source list to move the item out of.\n\t * @throws Throws if `sourceIndex` is not in the range [0, `list.length`).\n\t */\n\tmoveToEnd(sourceIndex: number, source: TMoveFrom): void;\n\n\t/**\n\t * Moves the specified item to the desired location in the list.\n\t * @param index - The index to move the item to.\n\t * This is based on the state of the list before moving the source item.\n\t * @param sourceIndex - The index of the item to move.\n\t * @throws Throws if any of the input indices are not in the range [0, `list.length`).\n\t */\n\tmoveToIndex(index: number, sourceIndex: number): void;\n\n\t/**\n\t * Moves the specified item to the desired location in the list.\n\t * @param index - The index to move the item to.\n\t * @param sourceIndex - The index of the item to move.\n\t * @param source - The source list to move the item out of.\n\t * @throws Throws if any of the input indices are not in the range [0, `list.length`).\n\t */\n\tmoveToIndex(index: number, sourceIndex: number, source: TMoveFrom): void;\n\n\t/**\n\t * Moves the specified items to the start of the list.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @throws Throws if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToStart(sourceStart: number, sourceEnd: number): void;\n\n\t/**\n\t * Moves the specified items to the start of the list.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @param source - The source list to move items out of.\n\t * @throws Throws if the types of any of the items being moved are not allowed in the destination list,\n\t * if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToStart(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;\n\n\t/**\n\t * Moves the specified items to the end of the list.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @throws Throws if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToEnd(sourceStart: number, sourceEnd: number): void;\n\n\t/**\n\t * Moves the specified items to the end of the list.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @param source - The source list to move items out of.\n\t * @throws Throws if the types of any of the items being moved are not allowed in the destination list,\n\t * if either of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToEnd(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;\n\n\t/**\n\t * Moves the specified items to the desired location within the list.\n\t * @param index - The index to move the items to.\n\t * This is based on the state of the list before moving the source items.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @throws Throws if any of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToIndex(index: number, sourceStart: number, sourceEnd: number): void;\n\n\t/**\n\t * Moves the specified items to the desired location within the list.\n\t * @param index - The index to move the items to.\n\t * @param sourceStart - The starting index of the range to move (inclusive).\n\t * @param sourceEnd - The ending index of the range to move (exclusive)\n\t * @param source - The source list to move items out of.\n\t * @throws Throws if the types of any of the items being moved are not allowed in the destination list,\n\t * if any of the input indices are not in the range [0, `list.length`) or if `sourceStart` is greater than `sourceEnd`.\n\t */\n\tmoveRangeToIndex(\n\t\tindex: number,\n\t\tsourceStart: number,\n\t\tsourceEnd: number,\n\t\tsource: TMoveFrom,\n\t): void;\n}\n\n/**\n * An object which supports property-based access to fields.\n */\nexport type TreeObjectNode<TSchema extends ObjectNodeSchema> = TreeObjectNodeFields<\n\tTSchema[\"objectNodeFieldsObject\"]\n>;\n\n/**\n * Helper for generating the properties of a {@link TreeObjectNode}.\n * @privateRemarks\n * This type is composed of four subtypes for each mutually exclusive combination of \"readonly\" and \"optional\".\n * If it were possible to map to getters and setters separately, the \"readonly\" cases would collapse, but this is not currently a feature in TS.\n * See https://github.com/microsoft/TypeScript/issues/43826 for more details on this limitation.\n */\nexport type TreeObjectNodeFields<\n\tTFields extends RestrictiveReadonlyRecord<string, TreeFieldSchema>,\n> = {\n\t// Filter for properties that are both assignable and optional; mark them `-readonly` and `?`.\n\t-readonly [key in keyof TFields as TFields[key][\"kind\"] extends AssignableFieldKinds\n\t\t? TFields[key][\"kind\"] extends typeof FieldKinds.optional\n\t\t\t? key\n\t\t\t: never\n\t\t: never]?: TreeField<TFields[key]>;\n} & {\n\t// Filter for properties that are assignable but are not optional; mark them `-readonly` and `-?`.\n\t-readonly [key in keyof TFields as TFields[key][\"kind\"] extends AssignableFieldKinds\n\t\t? TFields[key][\"kind\"] extends typeof FieldKinds.optional\n\t\t\t? never\n\t\t\t: key\n\t\t: never]-?: TreeField<TFields[key]>;\n} & {\n\t// Filter for properties that are not assignable but are optional; mark them `readonly` and `?`.\n\treadonly [key in keyof TFields as TFields[key][\"kind\"] extends AssignableFieldKinds\n\t\t? never\n\t\t: TFields[key][\"kind\"] extends typeof FieldKinds.optional\n\t\t? key\n\t\t: never]?: TreeField<TFields[key]>;\n} & {\n\t// Filter for properties that are not assignable and are not optional; mark them `readonly` and `-?`.\n\treadonly [key in keyof TFields as TFields[key][\"kind\"] extends AssignableFieldKinds\n\t\t? never\n\t\t: TFields[key][\"kind\"] extends typeof FieldKinds.optional\n\t\t? never\n\t\t: key]-?: TreeField<TFields[key]>;\n};\n\n/**\n * A map of string keys to tree objects.\n *\n * @privateRemarks\n * Add support for `clear` once we have established merge semantics for it.\n *\n */\nexport interface TreeMapNode<TSchema extends MapNodeSchema = MapNodeSchema>\n\textends TreeMapNodeBase<TreeField<TSchema[\"info\"], \"notEmpty\">> {}\n\n/**\n * A map of string keys to tree objects.\n *\n * @privateRemarks\n * Add support for `clear` once we have established merge semantics for it.\n *\n * @beta\n */\nexport interface TreeMapNodeBase<TOut, TIn = TOut> extends ReadonlyMap<string, TOut> {\n\t/**\n\t * Adds or updates an entry in the map with a specified `key` and a `value`.\n\t *\n\t * @param key - The key of the element to add to the map.\n\t * @param value - The value of the element to add to the map.\n\t *\n\t * @remarks\n\t * Setting the value at a key to `undefined` is equivalent to calling {@link TreeMapNodeBase.delete} with that key.\n\t */\n\tset(key: string, value: TIn | undefined): void;\n\n\t/**\n\t * Removes the specified element from this map by its `key`.\n\t *\n\t * @remarks\n\t * Note: unlike JavaScript's Map API, this method does not return a flag indicating whether or not the value was\n\t * deleted.\n\t *\n\t * @privateRemarks\n\t * Regarding the choice to not return a boolean: Since this data structure is distributed in nature, it isn't\n\t * possible to tell whether or not the item was deleted as a result of this method call. Returning a \"best guess\"\n\t * is more likely to create issues / promote bad usage patterns than offer useful information.\n\t *\n\t * @param key - The key of the element to remove from the map.\n\t */\n\tdelete(key: string): void;\n}\n\n/**\n * Given a field's schema, return the corresponding object in the proxy-based API.\n */\nexport type TreeField<\n\tTSchema extends TreeFieldSchema = TreeFieldSchema,\n\t// If \"notEmpty\", then optional fields will unbox to their content (not their content | undefined)\n\tEmptiness extends \"maybeEmpty\" | \"notEmpty\" = \"maybeEmpty\",\n> = TreeFieldInner<TSchema[\"kind\"], TSchema[\"allowedTypes\"], Emptiness>;\n\n/**\n * Helper for implementing {@link TreeField}.\n */\nexport type TreeFieldInner<\n\tKind extends FieldKind,\n\tTTypes extends AllowedTypes,\n\tEmptiness extends \"maybeEmpty\" | \"notEmpty\",\n> = Kind extends typeof FieldKinds.sequence\n\t? never // Sequences are only supported underneath FieldNodes. See FieldNode case in `ProxyNode`.\n\t: Kind extends typeof FieldKinds.required\n\t? TreeNodeUnion<TTypes>\n\t: Kind extends typeof FieldKinds.optional\n\t? TreeNodeUnion<TTypes> | (Emptiness extends \"notEmpty\" ? never : undefined)\n\t: unknown;\n\n/**\n * Given multiple node schema types, return the corresponding object type union in the proxy-based API.\n */\nexport type TreeNodeUnion<TTypes extends AllowedTypes> = TTypes extends readonly [Any]\n\t? unknown\n\t: {\n\t\t\t// TODO: Is the the best way to write this type function? Can it be simplified?\n\t\t\t// This first maps the tuple of AllowedTypes to a tuple of node API types.\n\t\t\t// Then, it uses [number] to index arbitrarily into that tuple, effectively converting the type tuple into a type union.\n\t\t\t[Index in keyof TTypes]: TTypes[Index] extends InternalTypedSchemaTypes.LazyItem<\n\t\t\t\tinfer InnerType\n\t\t\t>\n\t\t\t\t? InnerType extends TreeNodeSchema\n\t\t\t\t\t? TypedNode<InnerType>\n\t\t\t\t\t: never\n\t\t\t\t: never;\n\t  }[number];\n\n/**\n * Given a node's schema, return the corresponding object in the proxy-based API.\n */\nexport type TypedNode<TSchema extends TreeNodeSchema> = TSchema extends LeafNodeSchema\n\t? TreeValue<TSchema[\"info\"]>\n\t: TSchema extends MapNodeSchema\n\t? TreeMapNode<TSchema>\n\t: TSchema extends FieldNodeSchema\n\t? TreeListNodeOld<TSchema[\"info\"][\"allowedTypes\"]>\n\t: TSchema extends ObjectNodeSchema\n\t? TreeObjectNode<TSchema>\n\t: TreeNode;\n"]}