@fluidframework/tree 2.3.1 → 2.4.0-297027

package/lib/feature-libraries/editableTreeBinder.d.ts

@@ -2,104 +2,11 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type FieldKey, type ProtoNodes, type UpPath } from "../core/index.js";
-import type { Listeners, Listenable } from "../events/index.js";
-import type { FlexTreeNode } from "./flex-tree/index.js";
-/**
- * Binder events reflecting atomic data operations
- */
-export interface OperationBinderEvents {
-    remove(context: RemoveBindingContext): void;
-    insert(context: InsertBindingContext): void;
-    batch(context: BatchBindingContext): void;
-}
-/**
- * Binder events signaling state invalidation
- */
-export interface InvalidationBinderEvents {
-    invalidation(context: InvalidationBindingContext): void;
-}
-/**
- * Compare function, generic.
- */
-export type CompareFunction<T> = (a: T, b: T) => number;
-/**
- * Compare function for binder events.
- */
-export type BinderEventsCompare = CompareFunction<VisitorBindingContext>;
-/**
- * Compare function for anchors.
- */
-export type AnchorsCompare = CompareFunction<UpPath>;
-/**
- * Options to configure binder behavior.
- *
- * TODO: add more options:
- * `filterFn?: (context: BindingContext) => boolean;`
- * `pathPolicy?: "relative" | "absolute";`
- */
-export interface BinderOptions {
-    sortFn?: BinderEventsCompare;
-}
-/**
- * Specialized binder options for flushable binders.
- */
-export interface FlushableBinderOptions<E extends Listeners<E>> extends BinderOptions {
-    autoFlush: boolean;
-    autoFlushPolicy: keyof Listeners<E>;
-    sortAnchorsFn?: AnchorsCompare;
-}
-/**
- * Match policy for binding: subtree or path.
- *
- * - `subtree` match policy means that path filtering would return events matching the exact path and its subpaths,
- * ie. changes to (nested) children would be allowed to bubble up to parent listeners.
- * - {@link SubtreePolicy} match policy is  equivalent with `subtree` match policy, while allowing to specify a maximum
- * depth for the subtree.
- * - `path` match policy means that path filtering would return events matching the _exact_ path only. In this case
- * _exact_ semantics include interpreting an `undefined` _index_ field in the {@link PathStep} as a wildcard.
- *
- */
-export type MatchPolicy = SubtreePolicy | "subtree" | "path";
-/**
- * Subtree match policy where max depth can be specified.
- */
-export interface SubtreePolicy {
-    maxDepth: number;
-}
-/**
- * The data binder interface
- */
-export interface DataBinder<B extends OperationBinderEvents | InvalidationBinderEvents> {
-    /**
-     * Register an event listener
-     *
-     * @param anchor - The anchor to register the listener on
-     * @param eventType - The {@link BindingType} to listen for.
-     * @param eventTrees - The {@link BindPolicy}s to filter on.
-     * @param listener - The listener to register
-     */
-    register<K extends keyof Listeners<B>>(anchor: FlexTreeNode, eventType: K, eventTrees: BindPolicy[], listener?: B[K]): void;
-    /**
-     * Unregister all listeners.
-     */
-    unregisterAll(): void;
-}
-/**
- * An interface describing the ability to flush.
- */
-export interface Flushable<T> {
-    flush(): T;
-}
-/**
- * An interface describing a flushable data binder.
- */
-export interface FlushableDataBinder<B extends OperationBinderEvents | InvalidationBinderEvents> extends DataBinder<B>, Flushable<FlushableDataBinder<B>> {
-}
+import { type FieldKey, type UpPath } from "../core/index.js";
 /**
  * A step in a bind path
  */
-export interface PathStep {
+interface PathStep {
     /**
      * The field being traversed
      */
@@ -109,40 +16,6 @@ export interface PathStep {
      */
     readonly index?: number;
 }
-/**
- * The default type for a bind tree
- */
-export type BindTreeDefault = BindTree;
-/**
- * A bind tree is a compact representation of related {@link BindPath}s.
- */
-export interface BindTree<T = BindTreeDefault> extends PathStep {
-    readonly children: Map<FieldKey, T>;
-}
-/**
- * A bind policy is a combination of a {@link BindTree} and a {@link MatchPolicy}.
- */
-export interface BindPolicy {
-    readonly bindTree: BindTree;
-    readonly matchPolicy: MatchPolicy;
-}
-/**
- * Index symbol for syntax tree
- */
-export declare const indexSymbol: unique symbol;
-/**
- * A syntax node for the bind language
- *
- * The bind language is a compact representation of related {@link BindPath}s. It can be used to
- * simplify usage and construction of {@link BindTree}s.
- *
- * see {@link BindTree}
- * see {@link compileSyntaxTree}
- */
-export interface BindSyntaxTree {
-    readonly [indexSymbol]?: number;
-    readonly [key: string]: true | BindSyntaxTree;
-}
 /**
  * A top down path in a bind or path tree is a collection of {@link PathStep}s
  *
@@ -150,109 +23,9 @@ export interface BindSyntaxTree {
  * see {@link UpPath}
  */
 export type DownPath = PathStep[];
-/**
- * A bind path is a top down path in a bind tree
- */
-export type BindPath = DownPath;
-/**
- * A binding context specialized for {@link PathVisitor} triggered binding events.
- */
-export type VisitorBindingContext = RemoveBindingContext | InsertBindingContext;
-/**
- * Enumeration of binding categories
- */
-export declare const BindingType: {
-    readonly Remove: "remove";
-    readonly Insert: "insert";
-    readonly Invalidation: "invalidation";
-    readonly Batch: "batch";
-};
-/**
- * The type of a binding context
- */
-export type BindingContextType = (typeof BindingType)[keyof typeof BindingType];
-/**
- * The binding context attribution common to all binding events
- */
-export interface BindingContext {
-    readonly type: BindingContextType;
-}
-/**
- * The binding context for a remove event
- */
-export interface RemoveBindingContext extends BindingContext {
-    readonly type: typeof BindingType.Remove;
-    readonly path: UpPath;
-    readonly count: number;
-}
-/**
- * The binding context for an insert event
- */
-export interface InsertBindingContext extends BindingContext {
-    readonly type: typeof BindingType.Insert;
-    readonly path: UpPath;
-    readonly content: ProtoNodes;
-}
-/**
- * The binding context for an invalidation event
- */
-export interface InvalidationBindingContext extends BindingContext {
-    readonly type: typeof BindingType.Invalidation;
-}
-/**
- * The binding context for a batch event
- */
-export interface BatchBindingContext extends BindingContext {
-    readonly type: typeof BindingType.Batch;
-    readonly events: VisitorBindingContext[];
-}
 /**
  * Compute a top-town {@link DownPath} from an {@link UpPath}.
  */
 export declare function toDownPath(upPath: UpPath): DownPath;
-/**
- * Create a buffering data binder.
- */
-export declare function createDataBinderBuffering<E extends Listeners<E>>(view: Listenable<E>, options: FlushableBinderOptions<E>): FlushableDataBinder<OperationBinderEvents>;
-/**
- * Create a direct data binder.
- */
-export declare function createDataBinderDirect<E extends Listeners<E>>(view: Listenable<E>, options: BinderOptions): DataBinder<OperationBinderEvents>;
-/**
- * Create an invalidating data binder.
- */
-export declare function createDataBinderInvalidating<E extends Listeners<E>>(view: Listenable<E>, options: FlushableBinderOptions<E>): FlushableDataBinder<InvalidationBinderEvents>;
-/**
- * Create binder options. If not specified, the default values are:
- * - sortFn: no sorting
- */
-export declare function createBinderOptions({ sortFn, }: {
-    sortFn?: BinderEventsCompare;
-}): BinderOptions;
-/**
- * Create flushable binder options. If not specified, the default values are:
- * - sortFn: no sorting
- * - sortAnchorsFn: no sorting
- * - autoFlush: true
- */
-export declare function createFlushableBinderOptions<E extends Listeners<E>>({ sortFn, sortAnchorsFn, autoFlush, autoFlushPolicy, }: {
-    sortFn?: BinderEventsCompare;
-    sortAnchorsFn?: AnchorsCompare;
-    autoFlush?: boolean;
-    autoFlushPolicy: keyof Listeners<E>;
-}): FlushableBinderOptions<E>;
-/**
- * Utility to create a compare function from a list of compare functions.
- *
- * @param fns - a list of compare functions
- * @returns a compare function that can be used for sorting
- */
-export declare function comparePipeline<T>(...fns: CompareFunction<T>[]): CompareFunction<T>;
-/**
- * Compiles a (user friendly) syntax tree into the internal binding structure.
- * The syntax tree is a compact representation of related {@link BindPath}s.
- * The match policy can be specified. If not specified, the default value is "path".
- * @returns a {@link BindPolicy} object
- */
-export declare function compileSyntaxTree(syntaxTree: BindSyntaxTree, matchPolicy?: MatchPolicy): BindPolicy;
+export {};
 //# sourceMappingURL=editableTreeBinder.d.ts.map

package/lib/feature-libraries/editableTreeBinder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"editableTreeBinder.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/editableTreeBinder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAGN,KAAK,QAAQ,EAGb,KAAK,UAAU,EAEf,KAAK,MAAM,EAEX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAMzD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC5C,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,YAAY,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC,qBAAqB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC7B,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,CAAE,SAAQ,aAAa;IACpF,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;IACpC,aAAa,CAAC,EAAE,cAAc,CAAC;CAC/B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG,MAAM,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,qBAAqB,GAAG,wBAAwB;IACrF;;;;;;;OAOG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,SAAS,CAAC,CAAC,CAAC,EACpC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,CAAC,EACZ,UAAU,EAAE,UAAU,EAAE,EACxB,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GACb,IAAI,CAAC;IAER;;OAEG;IACH,aAAa,IAAI,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC3B,KAAK,IAAI,CAAC,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CACnC,CAAC,SAAS,qBAAqB,GAAG,wBAAwB,CACzD,SAAQ,UAAU,CAAC,CAAC,CAAC,EACrB,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAAG;AAEtC;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,eAAe,CAAE,SAAQ,QAAQ;IAC9D,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CAClC;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,eAAmC,CAAC;AAE5D;;;;;;;;GAQG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;CAKd,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC3D,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,MAAM,CAAC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC3D,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,MAAM,CAAC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IACjE,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,YAAY,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IAC1D,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC,KAAK,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACzC;AAsiBD;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAOnD;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAC/D,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAChC,mBAAmB,CAAC,qBAAqB,CAAC,CAE5C;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAC5D,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,OAAO,EAAE,aAAa,GACpB,UAAU,CAAC,qBAAqB,CAAC,CAEnC;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAClE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EACnB,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAChC,mBAAmB,CAAC,wBAAwB,CAAC,CAE/C;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,EACnC,MAAM,GACN,EAAE;IAAE,MAAM,CAAC,EAAE,mBAAmB,CAAA;CAAE,GAAG,aAAa,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,EACpE,MAAM,EACN,aAAa,EACb,SAAgB,EAChB,eAAe,GACf,EAAE;IACF,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;CACpC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAO5B;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,CAUnF;AAaD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAChC,UAAU,EAAE,cAAc,EAC1B,WAAW,CAAC,EAAE,WAAW,GACvB,UAAU,CAQZ"}
+{"version":3,"file":"editableTreeBinder.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/editableTreeBinder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAe,MAAM,kBAAkB,CAAC;AAE3E;;GAEG;AACH,UAAU,QAAQ;IACjB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;AAElC;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAOnD"}