@fluidframework/ai-collab 2.10.0-306579

package/lib/explicit-strategy/utils.js

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * TBD
+ */
+export function fail(message) {
+    throw new Error(message);
+}
+/**
+ * Map one iterable to another by transforming each element one at a time
+ * @param iterable - the iterable to transform
+ * @param map - the transformation function to run on each element of the iterable
+ * @returns a new iterable of elements which have been transformed by the `map` function
+ *
+ * @remarks originally from tree/src/util/utils.ts
+ */
+export function* mapIterable(iterable, map) {
+    for (const t of iterable) {
+        yield map(t);
+    }
+}
+/**
+ * Retrieve a value from a map with the given key, or create a new entry if the key is not in the map.
+ * @param map - The map to query/update
+ * @param key - The key to lookup in the map
+ * @param defaultValue - a function which returns a default value. This is called and used to set an initial value for the given key in the map if none exists
+ * @returns either the existing value for the given key, or the newly-created value (the result of `defaultValue`)
+ *
+ * @remarks originally from tree/src/util/utils.ts
+ */
+export function getOrCreate(map, key, defaultValue) {
+    let value = map.get(key);
+    if (value === undefined) {
+        value = defaultValue(key);
+        map.set(key, value);
+    }
+    return value;
+}
+//# sourceMappingURL=utils.js.map

package/lib/explicit-strategy/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/explicit-strategy/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH;;GAEG;AACH,MAAM,UAAU,IAAI,CAAC,OAAe;IACnC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,SAAS,CAAC,CAAC,WAAW,CAC3B,QAAqB,EACrB,GAAgB;IAEhB,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;QAC1B,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACd,CAAC;AACF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAC1B,GAAoB,EACpB,GAAM,EACN,YAA2B;IAE3B,IAAI,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Subset of Map interface.\n *\n * @remarks originally from tree/src/util/utils.ts\n */\nexport interface MapGetSet<K, V> {\n\tget(key: K): V | undefined;\n\tset(key: K, value: V): void;\n}\n\n/**\n * TBD\n */\nexport function fail(message: string): never {\n\tthrow new Error(message);\n}\n\n/**\n * Map one iterable to another by transforming each element one at a time\n * @param iterable - the iterable to transform\n * @param map - the transformation function to run on each element of the iterable\n * @returns a new iterable of elements which have been transformed by the `map` function\n *\n * @remarks originally from tree/src/util/utils.ts\n */\nexport function* mapIterable<T, U>(\n\titerable: Iterable<T>,\n\tmap: (t: T) => U,\n): IterableIterator<U> {\n\tfor (const t of iterable) {\n\t\tyield map(t);\n\t}\n}\n\n/**\n * Retrieve a value from a map with the given key, or create a new entry if the key is not in the map.\n * @param map - The map to query/update\n * @param key - The key to lookup in the map\n * @param defaultValue - a function which returns a default value. This is called and used to set an initial value for the given key in the map if none exists\n * @returns either the existing value for the given key, or the newly-created value (the result of `defaultValue`)\n *\n * @remarks originally from tree/src/util/utils.ts\n */\nexport function getOrCreate<K, V>(\n\tmap: MapGetSet<K, V>,\n\tkey: K,\n\tdefaultValue: (key: K) => V,\n): V {\n\tlet value = map.get(key);\n\tif (value === undefined) {\n\t\tvalue = defaultValue(key);\n\t\tmap.set(key, value);\n\t}\n\treturn value;\n}\n"]}

package/lib/implicit-strategy/index.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { type DifferenceCreate, type DifferenceChange, type DifferenceMove, type DifferenceRemove, type Difference, type ObjectPath, type Options, sharedTreeDiff, createMergableIdDiffSeries, createMergableDiffSeries, } from "./sharedTreeDiff.js";
+export { SharedTreeBranchManager } from "./sharedTreeBranchManager.js";
+export { sharedTreeTraverse, isTreeArrayNode, isTreeMapNode } from "./utils.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/implicit-strategy/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/implicit-strategy/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,GACxB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}

package/lib/implicit-strategy/index.js

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { sharedTreeDiff, createMergableIdDiffSeries, createMergableDiffSeries, } from "./sharedTreeDiff.js";
+export { SharedTreeBranchManager } from "./sharedTreeBranchManager.js";
+export { sharedTreeTraverse, isTreeArrayNode, isTreeMapNode } from "./utils.js";
+//# sourceMappingURL=index.js.map

package/lib/implicit-strategy/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/implicit-strategy/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAQN,cAAc,EACd,0BAA0B,EAC1B,wBAAwB,GACxB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\ttype DifferenceCreate,\n\ttype DifferenceChange,\n\ttype DifferenceMove,\n\ttype DifferenceRemove,\n\ttype Difference,\n\ttype ObjectPath,\n\ttype Options,\n\tsharedTreeDiff,\n\tcreateMergableIdDiffSeries,\n\tcreateMergableDiffSeries,\n} from \"./sharedTreeDiff.js\";\n\nexport { SharedTreeBranchManager } from \"./sharedTreeBranchManager.js\";\n\nexport { sharedTreeTraverse, isTreeArrayNode, isTreeMapNode } from \"./utils.js\";\n"]}

package/lib/implicit-strategy/sharedTreeBranchManager.d.ts

@@ -0,0 +1,63 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ImplicitFieldSchema, TreeArrayNode, TreeViewConfiguration } from "@fluidframework/tree";
+import { type BranchableTree, type TreeBranchFork, type TreeViewAlpha } from "@fluidframework/tree/alpha";
+import type { z } from "zod";
+import { type Difference, type ObjectPath } from "./sharedTreeDiff.js";
+/**
+ * Manages determining the differences between two branches of a SharedTree represented as an actual tree node or a plain javascript object
+ * and applies said differences to the original SharedTree branch.
+ *
+ * @alpha
+ */
+export declare class SharedTreeBranchManager {
+    private readonly objectSchema?;
+    private readonly nodeIdAttributeName?;
+    constructor(params?: {
+        objectSchema?: z.Schema;
+        nodeIdAttributeName?: string;
+    });
+    /**
+     * Compares the differences between either two objects or a TreeNode and a plain object.
+     * TODO: Should allow comparing two tree nodes? Should we allow comparing two plain objects? Or just leave as tree node vs object?
+     */
+    compare(obj: Record<string, unknown> | TreeArrayNode, newObj: Record<string, unknown> | unknown[]): Difference[];
+    /**
+     * Produces a set of differences based on two versions of an object, applies the changes to the first one,
+     * and returns the set of differences.
+     */
+    mergeObject(obj: Record<string, unknown> | TreeArrayNode, llmResponse: Record<string, unknown> | unknown[]): Difference[];
+    /**
+     * produces a diff between two objects and merges the differences.
+     */
+    checkoutNewMergedBranch<T extends ImplicitFieldSchema>(treeView: TreeViewAlpha<T>, treeViewConfiguration: TreeViewConfiguration<T>, absolutePathToObjectNode: ObjectPath, llmResponse: Record<string, unknown> | unknown[]): {
+        differences: Difference[];
+        originalBranch: BranchableTree;
+        forkBranch: TreeBranchFork;
+        forkView: TreeViewAlpha<T>;
+        newBranchTargetNode: Record<string, unknown> | TreeArrayNode;
+    };
+    /**
+     * Creates a forked branch of a tree view.
+     */
+    checkoutNewMergedBranchV2<T extends ImplicitFieldSchema>(treeView: TreeViewAlpha<T>, treeViewConfiguration: TreeViewConfiguration<T>, absolutePathToObjectNode: ObjectPath): {
+        originalBranch: BranchableTree;
+        forkBranch: TreeBranchFork;
+        forkView: TreeViewAlpha<T>;
+        newBranchTargetNode: Record<string, unknown> | TreeArrayNode;
+    };
+    /**
+     * Handles applying an array of differences to an object in the proper order and making any necessary adjustments as each diff
+     * is applied.
+     *
+     * @returns an array of differences that were not applied due to some kind of conflict or error.
+     */
+    mergeDiffs(diffs: Difference[], objectToUpdate: Record<string, unknown> | TreeArrayNode): Set<Difference>;
+    /**
+     * Applies an individual diff to the objectToUpdate.
+     */
+    applyDiff(diff: Difference, objectToUpdate: Record<string, unknown> | TreeArrayNode): boolean;
+}
+//# sourceMappingURL=sharedTreeBranchManager.d.ts.map

package/lib/implicit-strategy/sharedTreeBranchManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeBranchManager.d.ts","sourceRoot":"","sources":["../../src/implicit-strategy/sharedTreeBranchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,mBAAmB,EACnB,aAAa,EAEb,qBAAqB,EACrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAIN,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,aAAa,EAElB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAIN,KAAK,UAAU,EACf,KAAK,UAAU,EACf,MAAM,qBAAqB,CAAC;AAG7B;;;;;GAKG;AACH,qBAAa,uBAAuB;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAuB;IACrD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAqB;gBAEvC,MAAM,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,MAAM,CAAA;KAAE;IAKrF;;;OAGG;IACI,OAAO,CACb,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,EAC5C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GACzC,UAAU,EAAE;IAyBf;;;OAGG;IACI,WAAW,CACjB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,EAC5C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAC9C,UAAU,EAAE;IAMf;;OAEG;IACI,uBAAuB,CAAC,CAAC,SAAS,mBAAmB,EAC3D,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAC1B,qBAAqB,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAC/C,wBAAwB,EAAE,UAAU,EACpC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,GAC9C;QACF,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,cAAc,EAAE,cAAc,CAAC;QAC/B,UAAU,EAAE,cAAc,CAAC;QAC3B,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC3B,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC;KAC7D;IA2BD;;OAEG;IACI,yBAAyB,CAAC,CAAC,SAAS,mBAAmB,EAC7D,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,EAC1B,qBAAqB,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAC/C,wBAAwB,EAAE,UAAU,GAElC;QACF,cAAc,EAAE,cAAc,CAAC;QAC/B,UAAU,EAAE,cAAc,CAAC;QAC3B,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC3B,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC;KAC7D;IAaD;;;;;OAKG;IACI,UAAU,CAChB,KAAK,EAAE,UAAU,EAAE,EACnB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,GACrD,GAAG,CAAC,UAAU,CAAC;IAclB;;OAEG;IACI,SAAS,CACf,IAAI,EAAE,UAAU,EAChB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa,GACrD,OAAO;CA4FV"}

package/lib/implicit-strategy/sharedTreeBranchManager.js

@@ -0,0 +1,213 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { 
+// TODO: Migrate to newer branching API (`TreeContext`)
+// eslint-disable-next-line import/no-deprecated
+getBranch,
+// eslint-disable-next-line import/no-internal-modules -- This package depends on the branching APIs in Tree which are currently alpha
+ } from "@fluidframework/tree/alpha";
+import { createMergableDiffSeries, createMergableIdDiffSeries, sharedTreeDiff, } from "./sharedTreeDiff.js";
+import { isTreeMapNode, isTreeArrayNode, sharedTreeTraverse } from "./utils.js";
+/**
+ * Manages determining the differences between two branches of a SharedTree represented as an actual tree node or a plain javascript object
+ * and applies said differences to the original SharedTree branch.
+ *
+ * @alpha
+ */
+export class SharedTreeBranchManager {
+    constructor(params) {
+        this.objectSchema = params?.objectSchema;
+        this.nodeIdAttributeName = params?.nodeIdAttributeName;
+    }
+    /**
+     * Compares the differences between either two objects or a TreeNode and a plain object.
+     * TODO: Should allow comparing two tree nodes? Should we allow comparing two plain objects? Or just leave as tree node vs object?
+     */
+    compare(obj, newObj) {
+        // By validating that the incoming object matches the schema, we can confirm that any property
+        // deletions/updates/additions are valid.
+        if (this.objectSchema !== undefined) {
+            const res = this.objectSchema.safeParse(newObj);
+            if (res.success === false) {
+                throw new TypeError("Invalid data");
+            }
+        }
+        const diffTotality = sharedTreeDiff(obj, newObj, {
+            useObjectIds: this.nodeIdAttributeName === undefined
+                ? undefined
+                : { idAttributeName: this.nodeIdAttributeName },
+            cyclesFix: true,
+        });
+        if (this.nodeIdAttributeName !== undefined) {
+            return createMergableIdDiffSeries(obj, diffTotality, this.nodeIdAttributeName);
+        }
+        return createMergableDiffSeries(diffTotality);
+    }
+    /**
+     * Produces a set of differences based on two versions of an object, applies the changes to the first one,
+     * and returns the set of differences.
+     */
+    mergeObject(obj, llmResponse) {
+        const differences = this.compare(obj, llmResponse);
+        this.mergeDiffs(differences, obj);
+        return differences;
+    }
+    /**
+     * produces a diff between two objects and merges the differences.
+     */
+    checkoutNewMergedBranch(treeView, treeViewConfiguration, absolutePathToObjectNode, llmResponse) {
+        // eslint-disable-next-line import/no-deprecated
+        const originalBranch = getBranch(treeView);
+        const forkBranch = originalBranch.branch();
+        const forkView = forkBranch.viewWith(treeViewConfiguration);
+        console.log("traveling to absolute path from root:", absolutePathToObjectNode);
+        const newBranchTargetNode = sharedTreeTraverse(forkView.root, absolutePathToObjectNode);
+        console.log("initiating compare between old and new branch target nodes", { ...newBranchTargetNode }, { ...llmResponse });
+        console.log("newBranchTargetNode", { ...newBranchTargetNode });
+        console.log("llmResponse", { ...llmResponse });
+        const differences = this.compare(newBranchTargetNode, llmResponse);
+        // const differences = [];
+        this.mergeDiffs(differences, newBranchTargetNode);
+        return { differences, originalBranch, forkBranch, forkView, newBranchTargetNode };
+    }
+    /**
+     * Creates a forked branch of a tree view.
+     */
+    checkoutNewMergedBranchV2(treeView, treeViewConfiguration, absolutePathToObjectNode) {
+        // eslint-disable-next-line import/no-deprecated
+        const originalBranch = getBranch(treeView);
+        const forkBranch = originalBranch.branch();
+        const forkView = forkBranch.viewWith(treeViewConfiguration);
+        const newBranchTargetNode = sharedTreeTraverse(forkView.root, absolutePathToObjectNode);
+        // this.mergeDiffs(differences, newBranchTargetNode);
+        return { originalBranch, forkBranch, forkView, newBranchTargetNode };
+    }
+    /**
+     * Handles applying an array of differences to an object in the proper order and making any necessary adjustments as each diff
+     * is applied.
+     *
+     * @returns an array of differences that were not applied due to some kind of conflict or error.
+     */
+    mergeDiffs(diffs, objectToUpdate) {
+        const unappliedDiffs = new Set();
+        for (const diff of diffs) {
+            const isDiffApplied = this.applyDiff(diff, objectToUpdate);
+            if (isDiffApplied === false) {
+                unappliedDiffs.add(diff);
+            }
+        }
+        return unappliedDiffs;
+    }
+    /**
+     * Applies an individual diff to the objectToUpdate.
+     */
+    applyDiff(diff, objectToUpdate) {
+        const targetObject = getTargetObjectFromPath(diff.path, objectToUpdate);
+        if (isTreeMapNode(targetObject)) {
+            switch (diff.type) {
+                case "CHANGE":
+                case "CREATE": {
+                    // This code is doing non-schema aware editing, which is not a supported feature of this API.
+                    // Casting to any is a way to get this unsupported and rather unsafe operation to compile.
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                    targetObject.set(diff.path[diff.path.length - 1], diff.value);
+                    return true;
+                }
+                case "REMOVE": {
+                    targetObject.delete(diff.path[diff.path.length - 1]);
+                    return true;
+                }
+                default: {
+                    throw new TypeError("Unsupported diff type for Map Tree Node");
+                }
+            }
+        }
+        else if (isTreeArrayNode(targetObject)) {
+            const targetIndex = diff.path[diff.path.length - 1];
+            const isTargetIndexValid = targetIndex >= 0 && targetIndex <= targetObject.length - 1;
+            switch (diff.type) {
+                case "CHANGE":
+                case "CREATE": {
+                    if (isTargetIndexValid) {
+                        // This code is doing non-schema aware editing, which is not a supported feature of this API.
+                        // Casting to any is a way to get this unsupported and rather unsafe operation to compile.
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                        targetObject.insertAt(targetIndex, diff.value);
+                        return true;
+                    }
+                    else {
+                        // This code is doing non-schema aware editing, which is not a supported feature of this API.
+                        // Casting to any is a way to get this unsupported and rather unsafe operation to compile.
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+                        targetObject.insertAtEnd(diff.value);
+                        console.warn("CREATE diff specified an invalid index, defaulting to pushing to end of array");
+                        return false;
+                    }
+                }
+                case "MOVE": {
+                    if (isTargetIndexValid) {
+                        if (diff.newIndex > targetIndex) {
+                            // forward move must use i + 1
+                            targetObject.moveToIndex(diff.newIndex + 1, targetIndex);
+                        }
+                        else if (diff.newIndex < targetIndex) {
+                            // backwards move, using i directly is fine
+                            targetObject.moveToIndex(diff.newIndex, targetIndex);
+                        }
+                        return true;
+                    }
+                    else {
+                        console.warn("MOVE diff specified an invalid index, ignoring.");
+                        return false;
+                    }
+                }
+                case "REMOVE": {
+                    if (isTargetIndexValid) {
+                        targetObject.removeAt(targetIndex);
+                        return true;
+                    }
+                    else {
+                        console.warn("REMOVE diff specified an invalid index, ignoring.");
+                        return false;
+                    }
+                }
+                default: {
+                    throw new TypeError("Unsupported diff type for Array Tree Node");
+                }
+            }
+        }
+        else if (typeof targetObject === "object" && targetObject !== null) {
+            switch (diff.type) {
+                case "CHANGE":
+                case "CREATE": {
+                    targetObject[diff.path[diff.path.length - 1]] = diff.value;
+                    return true;
+                }
+                case "REMOVE": {
+                    // We can't use the delete keyword on a tree node.
+                    targetObject[diff.path[diff.path.length - 1]] = undefined;
+                    return false;
+                }
+                default: {
+                    throw new TypeError("Unsupported diff type for Object Tree Node");
+                }
+            }
+        }
+        else {
+            throw new TypeError("Unsupported object type for diff application");
+        }
+    }
+}
+/**
+ * Returns the target object that the given diff should be applied to.
+ */
+function getTargetObjectFromPath(path, object) {
+    let targetObject = object;
+    if (path.length > 1) {
+        targetObject = sharedTreeTraverse(object, path.slice(0, -1));
+    }
+    return targetObject;
+}
+//# sourceMappingURL=sharedTreeBranchManager.js.map

package/lib/implicit-strategy/sharedTreeBranchManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeBranchManager.js","sourceRoot":"","sources":["../../src/implicit-strategy/sharedTreeBranchManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO;AACN,uDAAuD;AACvD,gDAAgD;AAChD,SAAS;AAIT,sIAAsI;EACtI,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EACN,wBAAwB,EACxB,0BAA0B,EAC1B,cAAc,GAGd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,OAAO,uBAAuB;IAInC,YAAmB,MAAkE;QACpF,IAAI,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,CAAC;QACzC,IAAI,CAAC,mBAAmB,GAAG,MAAM,EAAE,mBAAmB,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,OAAO,CACb,GAA4C,EAC5C,MAA2C;QAE3C,8FAA8F;QAC9F,yCAAyC;QACzC,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,GAAG,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;gBAC3B,MAAM,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC;YACrC,CAAC;QACF,CAAC;QAED,MAAM,YAAY,GAAG,cAAc,CAAC,GAA0C,EAAE,MAAM,EAAE;YACvF,YAAY,EACX,IAAI,CAAC,mBAAmB,KAAK,SAAS;gBACrC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,mBAAmB,EAAE;YACjD,SAAS,EAAE,IAAI;SACf,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;YAC5C,OAAO,0BAA0B,CAAC,GAAG,EAAE,YAAY,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,wBAAwB,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,WAAW,CACjB,GAA4C,EAC5C,WAAgD;QAEhD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAClC,OAAO,WAAW,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,uBAAuB,CAC7B,QAA0B,EAC1B,qBAA+C,EAC/C,wBAAoC,EACpC,WAAgD;QAQhD,gDAAgD;QAChD,MAAM,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAqB,CAAC;QAEhF,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,wBAAwB,CAAC,CAAC;QAC/E,MAAM,mBAAmB,GAAG,kBAAkB,CAC7C,QAAQ,CAAC,IAAwE,EACjF,wBAAwB,CACmB,CAAC;QAE7C,OAAO,CAAC,GAAG,CACV,4DAA4D,EAC5D,EAAE,GAAG,mBAAmB,EAAE,EAC1B,EAAE,GAAG,WAAW,EAAE,CAClB,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,GAAG,mBAAmB,EAAE,CAAC,CAAC;QAC/D,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;QAE/C,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,WAAW,CAAC,CAAC;QACnE,0BAA0B;QAC1B,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;QAElD,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IACnF,CAAC;IAED;;OAEG;IACI,yBAAyB,CAC/B,QAA0B,EAC1B,qBAA+C,EAC/C,wBAAoC;QAQpC,gDAAgD;QAChD,MAAM,cAAc,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAqB,CAAC;QAChF,MAAM,mBAAmB,GAAG,kBAAkB,CAC7C,QAAQ,CAAC,IAA6D,EACtE,wBAAwB,CACmB,CAAC;QAC7C,qDAAqD;QACrD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAChB,KAAmB,EACnB,cAAuD;QAEvD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAc,CAAC;QAE7C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC1B,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;YAE3D,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;gBAC7B,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,OAAO,cAAc,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,SAAS,CACf,IAAgB,EAChB,cAAuD;QAEvD,MAAM,YAAY,GAAY,uBAAuB,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAEjF,IAAI,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;YACjC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,6FAA6F;oBAC7F,0FAA0F;oBAC1F,qGAAqG;oBACrG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,EAAE,IAAI,CAAC,KAAY,CAAC,CAAC;oBAC/E,OAAO,IAAI,CAAC;gBACb,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC,CAAC;oBAC/D,OAAO,IAAI,CAAC;gBACb,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,SAAS,CAAC,yCAAyC,CAAC,CAAC;gBAChE,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,eAAe,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC;YAC9D,MAAM,kBAAkB,GAAG,WAAW,IAAI,CAAC,IAAI,WAAW,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;YACtF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,IAAI,kBAAkB,EAAE,CAAC;wBACxB,6FAA6F;wBAC7F,0FAA0F;wBAC1F,qGAAqG;wBACrG,YAAY,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,KAAY,CAAC,CAAC;wBACtD,OAAO,IAAI,CAAC;oBACb,CAAC;yBAAM,CAAC;wBACP,6FAA6F;wBAC7F,0FAA0F;wBAC1F,qGAAqG;wBACrG,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,KAAY,CAAC,CAAC;wBAC5C,OAAO,CAAC,IAAI,CACX,+EAA+E,CAC/E,CAAC;wBACF,OAAO,KAAK,CAAC;oBACd,CAAC;gBACF,CAAC;gBACD,KAAK,MAAM,CAAC,CAAC,CAAC;oBACb,IAAI,kBAAkB,EAAE,CAAC;wBACxB,IAAI,IAAI,CAAC,QAAQ,GAAG,WAAW,EAAE,CAAC;4BACjC,8BAA8B;4BAC9B,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC;wBAC1D,CAAC;6BAAM,IAAI,IAAI,CAAC,QAAQ,GAAG,WAAW,EAAE,CAAC;4BACxC,2CAA2C;4BAC3C,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACtD,CAAC;wBACD,OAAO,IAAI,CAAC;oBACb,CAAC;yBAAM,CAAC;wBACP,OAAO,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;wBAChE,OAAO,KAAK,CAAC;oBACd,CAAC;gBACF,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,IAAI,kBAAkB,EAAE,CAAC;wBACxB,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;wBACnC,OAAO,IAAI,CAAC;oBACb,CAAC;yBAAM,CAAC;wBACP,OAAO,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;wBAClE,OAAO,KAAK,CAAC;oBACd,CAAC;gBACF,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,SAAS,CAAC,2CAA2C,CAAC,CAAC;gBAClE,CAAC;YACF,CAAC;QACF,CAAC;aAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACtE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,KAAK,QAAQ,CAAC;gBACd,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;oBACrE,OAAO,IAAI,CAAC;gBACb,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACf,kDAAkD;oBAClD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC,GAAG,SAAS,CAAC;oBACpE,OAAO,KAAK,CAAC;gBACd,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACT,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;gBACnE,CAAC;YACF,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;QACrE,CAAC;IACF,CAAC;CACD;AAED;;GAEG;AACH,SAAS,uBAAuB,CAC/B,IAAgB,EAChB,MAA+C;IAE/C,IAAI,YAAY,GAAY,MAAM,CAAC;IACnC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,YAAY,GAAG,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,YAAY,CAAC;AACrB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tImplicitFieldSchema,\n\tTreeArrayNode,\n\tTreeMapNode,\n\tTreeViewConfiguration,\n} from \"@fluidframework/tree\";\nimport {\n\t// TODO: Migrate to newer branching API (`TreeContext`)\n\t// eslint-disable-next-line import/no-deprecated\n\tgetBranch,\n\ttype BranchableTree,\n\ttype TreeBranchFork,\n\ttype TreeViewAlpha,\n\t// eslint-disable-next-line import/no-internal-modules -- This package depends on the branching APIs in Tree which are currently alpha\n} from \"@fluidframework/tree/alpha\";\nimport type { z } from \"zod\";\n\nimport {\n\tcreateMergableDiffSeries,\n\tcreateMergableIdDiffSeries,\n\tsharedTreeDiff,\n\ttype Difference,\n\ttype ObjectPath,\n} from \"./sharedTreeDiff.js\";\nimport { isTreeMapNode, isTreeArrayNode, sharedTreeTraverse } from \"./utils.js\";\n\n/**\n * Manages determining the differences between two branches of a SharedTree represented as an actual tree node or a plain javascript object\n * and applies said differences to the original SharedTree branch.\n *\n * @alpha\n */\nexport class SharedTreeBranchManager {\n\tprivate readonly objectSchema?: z.Schema | undefined;\n\tprivate readonly nodeIdAttributeName?: string | undefined;\n\n\tpublic constructor(params?: { objectSchema?: z.Schema; nodeIdAttributeName?: string }) {\n\t\tthis.objectSchema = params?.objectSchema;\n\t\tthis.nodeIdAttributeName = params?.nodeIdAttributeName;\n\t}\n\n\t/**\n\t * Compares the differences between either two objects or a TreeNode and a plain object.\n\t * TODO: Should allow comparing two tree nodes? Should we allow comparing two plain objects? Or just leave as tree node vs object?\n\t */\n\tpublic compare(\n\t\tobj: Record<string, unknown> | TreeArrayNode,\n\t\tnewObj: Record<string, unknown> | unknown[],\n\t): Difference[] {\n\t\t// By validating that the incoming object matches the schema, we can confirm that any property\n\t\t// deletions/updates/additions are valid.\n\t\tif (this.objectSchema !== undefined) {\n\t\t\tconst res = this.objectSchema.safeParse(newObj);\n\t\t\tif (res.success === false) {\n\t\t\t\tthrow new TypeError(\"Invalid data\");\n\t\t\t}\n\t\t}\n\n\t\tconst diffTotality = sharedTreeDiff(obj as Record<string, unknown> | unknown[], newObj, {\n\t\t\tuseObjectIds:\n\t\t\t\tthis.nodeIdAttributeName === undefined\n\t\t\t\t\t? undefined\n\t\t\t\t\t: { idAttributeName: this.nodeIdAttributeName },\n\t\t\tcyclesFix: true,\n\t\t});\n\n\t\tif (this.nodeIdAttributeName !== undefined) {\n\t\t\treturn createMergableIdDiffSeries(obj, diffTotality, this.nodeIdAttributeName);\n\t\t}\n\n\t\treturn createMergableDiffSeries(diffTotality);\n\t}\n\n\t/**\n\t * Produces a set of differences based on two versions of an object, applies the changes to the first one,\n\t * and returns the set of differences.\n\t */\n\tpublic mergeObject(\n\t\tobj: Record<string, unknown> | TreeArrayNode,\n\t\tllmResponse: Record<string, unknown> | unknown[],\n\t): Difference[] {\n\t\tconst differences = this.compare(obj, llmResponse);\n\t\tthis.mergeDiffs(differences, obj);\n\t\treturn differences;\n\t}\n\n\t/**\n\t * produces a diff between two objects and merges the differences.\n\t */\n\tpublic checkoutNewMergedBranch<T extends ImplicitFieldSchema>(\n\t\ttreeView: TreeViewAlpha<T>,\n\t\ttreeViewConfiguration: TreeViewConfiguration<T>,\n\t\tabsolutePathToObjectNode: ObjectPath,\n\t\tllmResponse: Record<string, unknown> | unknown[],\n\t): {\n\t\tdifferences: Difference[];\n\t\toriginalBranch: BranchableTree;\n\t\tforkBranch: TreeBranchFork;\n\t\tforkView: TreeViewAlpha<T>;\n\t\tnewBranchTargetNode: Record<string, unknown> | TreeArrayNode;\n\t} {\n\t\t// eslint-disable-next-line import/no-deprecated\n\t\tconst originalBranch = getBranch(treeView);\n\t\tconst forkBranch = originalBranch.branch();\n\t\tconst forkView = forkBranch.viewWith(treeViewConfiguration) as TreeViewAlpha<T>;\n\n\t\tconsole.log(\"traveling to absolute path from root:\", absolutePathToObjectNode);\n\t\tconst newBranchTargetNode = sharedTreeTraverse(\n\t\t\tforkView.root as unknown as TreeMapNode | TreeArrayNode | Record<string, unknown>,\n\t\t\tabsolutePathToObjectNode,\n\t\t) as Record<string, unknown> | TreeArrayNode;\n\n\t\tconsole.log(\n\t\t\t\"initiating compare between old and new branch target nodes\",\n\t\t\t{ ...newBranchTargetNode },\n\t\t\t{ ...llmResponse },\n\t\t);\n\t\tconsole.log(\"newBranchTargetNode\", { ...newBranchTargetNode });\n\t\tconsole.log(\"llmResponse\", { ...llmResponse });\n\n\t\tconst differences = this.compare(newBranchTargetNode, llmResponse);\n\t\t// const differences = [];\n\t\tthis.mergeDiffs(differences, newBranchTargetNode);\n\n\t\treturn { differences, originalBranch, forkBranch, forkView, newBranchTargetNode };\n\t}\n\n\t/**\n\t * Creates a forked branch of a tree view.\n\t */\n\tpublic checkoutNewMergedBranchV2<T extends ImplicitFieldSchema>(\n\t\ttreeView: TreeViewAlpha<T>,\n\t\ttreeViewConfiguration: TreeViewConfiguration<T>,\n\t\tabsolutePathToObjectNode: ObjectPath,\n\t\t// differences: Difference[],\n\t): {\n\t\toriginalBranch: BranchableTree;\n\t\tforkBranch: TreeBranchFork;\n\t\tforkView: TreeViewAlpha<T>;\n\t\tnewBranchTargetNode: Record<string, unknown> | TreeArrayNode;\n\t} {\n\t\t// eslint-disable-next-line import/no-deprecated\n\t\tconst originalBranch = getBranch(treeView);\n\t\tconst forkBranch = originalBranch.branch();\n\t\tconst forkView = forkBranch.viewWith(treeViewConfiguration) as TreeViewAlpha<T>;\n\t\tconst newBranchTargetNode = sharedTreeTraverse(\n\t\t\tforkView.root as TreeMapNode | TreeArrayNode | Record<string, unknown>,\n\t\t\tabsolutePathToObjectNode,\n\t\t) as Record<string, unknown> | TreeArrayNode;\n\t\t// this.mergeDiffs(differences, newBranchTargetNode);\n\t\treturn { originalBranch, forkBranch, forkView, newBranchTargetNode };\n\t}\n\n\t/**\n\t * Handles applying an array of differences to an object in the proper order and making any necessary adjustments as each diff\n\t * is applied.\n\t *\n\t * @returns an array of differences that were not applied due to some kind of conflict or error.\n\t */\n\tpublic mergeDiffs(\n\t\tdiffs: Difference[],\n\t\tobjectToUpdate: Record<string, unknown> | TreeArrayNode,\n\t): Set<Difference> {\n\t\tconst unappliedDiffs = new Set<Difference>();\n\n\t\tfor (const diff of diffs) {\n\t\t\tconst isDiffApplied = this.applyDiff(diff, objectToUpdate);\n\n\t\t\tif (isDiffApplied === false) {\n\t\t\t\tunappliedDiffs.add(diff);\n\t\t\t}\n\t\t}\n\n\t\treturn unappliedDiffs;\n\t}\n\n\t/**\n\t * Applies an individual diff to the objectToUpdate.\n\t */\n\tpublic applyDiff(\n\t\tdiff: Difference,\n\t\tobjectToUpdate: Record<string, unknown> | TreeArrayNode,\n\t): boolean {\n\t\tconst targetObject: unknown = getTargetObjectFromPath(diff.path, objectToUpdate);\n\n\t\tif (isTreeMapNode(targetObject)) {\n\t\t\tswitch (diff.type) {\n\t\t\t\tcase \"CHANGE\":\n\t\t\t\tcase \"CREATE\": {\n\t\t\t\t\t// This code is doing non-schema aware editing, which is not a supported feature of this API.\n\t\t\t\t\t// Casting to any is a way to get this unsupported and rather unsafe operation to compile.\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any\n\t\t\t\t\ttargetObject.set(diff.path[diff.path.length - 1] as string, diff.value as any);\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tcase \"REMOVE\": {\n\t\t\t\t\ttargetObject.delete(diff.path[diff.path.length - 1] as string);\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tdefault: {\n\t\t\t\t\tthrow new TypeError(\"Unsupported diff type for Map Tree Node\");\n\t\t\t\t}\n\t\t\t}\n\t\t} else if (isTreeArrayNode(targetObject)) {\n\t\t\tconst targetIndex = diff.path[diff.path.length - 1] as number;\n\t\t\tconst isTargetIndexValid = targetIndex >= 0 && targetIndex <= targetObject.length - 1;\n\t\t\tswitch (diff.type) {\n\t\t\t\tcase \"CHANGE\":\n\t\t\t\tcase \"CREATE\": {\n\t\t\t\t\tif (isTargetIndexValid) {\n\t\t\t\t\t\t// This code is doing non-schema aware editing, which is not a supported feature of this API.\n\t\t\t\t\t\t// Casting to any is a way to get this unsupported and rather unsafe operation to compile.\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any\n\t\t\t\t\t\ttargetObject.insertAt(targetIndex, diff.value as any);\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// This code is doing non-schema aware editing, which is not a supported feature of this API.\n\t\t\t\t\t\t// Casting to any is a way to get this unsupported and rather unsafe operation to compile.\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any\n\t\t\t\t\t\ttargetObject.insertAtEnd(diff.value as any);\n\t\t\t\t\t\tconsole.warn(\n\t\t\t\t\t\t\t\"CREATE diff specified an invalid index, defaulting to pushing to end of array\",\n\t\t\t\t\t\t);\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tcase \"MOVE\": {\n\t\t\t\t\tif (isTargetIndexValid) {\n\t\t\t\t\t\tif (diff.newIndex > targetIndex) {\n\t\t\t\t\t\t\t// forward move must use i + 1\n\t\t\t\t\t\t\ttargetObject.moveToIndex(diff.newIndex + 1, targetIndex);\n\t\t\t\t\t\t} else if (diff.newIndex < targetIndex) {\n\t\t\t\t\t\t\t// backwards move, using i directly is fine\n\t\t\t\t\t\t\ttargetObject.moveToIndex(diff.newIndex, targetIndex);\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tconsole.warn(\"MOVE diff specified an invalid index, ignoring.\");\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tcase \"REMOVE\": {\n\t\t\t\t\tif (isTargetIndexValid) {\n\t\t\t\t\t\ttargetObject.removeAt(targetIndex);\n\t\t\t\t\t\treturn true;\n\t\t\t\t\t} else {\n\t\t\t\t\t\tconsole.warn(\"REMOVE diff specified an invalid index, ignoring.\");\n\t\t\t\t\t\treturn false;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tdefault: {\n\t\t\t\t\tthrow new TypeError(\"Unsupported diff type for Array Tree Node\");\n\t\t\t\t}\n\t\t\t}\n\t\t} else if (typeof targetObject === \"object\" && targetObject !== null) {\n\t\t\tswitch (diff.type) {\n\t\t\t\tcase \"CHANGE\":\n\t\t\t\tcase \"CREATE\": {\n\t\t\t\t\ttargetObject[diff.path[diff.path.length - 1] as string] = diff.value;\n\t\t\t\t\treturn true;\n\t\t\t\t}\n\t\t\t\tcase \"REMOVE\": {\n\t\t\t\t\t// We can't use the delete keyword on a tree node.\n\t\t\t\t\ttargetObject[diff.path[diff.path.length - 1] as string] = undefined;\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tdefault: {\n\t\t\t\t\tthrow new TypeError(\"Unsupported diff type for Object Tree Node\");\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tthrow new TypeError(\"Unsupported object type for diff application\");\n\t\t}\n\t}\n}\n\n/**\n * Returns the target object that the given diff should be applied to.\n */\nfunction getTargetObjectFromPath(\n\tpath: ObjectPath,\n\tobject: Record<string, unknown> | TreeArrayNode,\n): unknown {\n\tlet targetObject: unknown = object;\n\tif (path.length > 1) {\n\t\ttargetObject = sharedTreeTraverse(object, path.slice(0, -1));\n\t}\n\treturn targetObject;\n}\n"]}

package/lib/implicit-strategy/sharedTreeDiff.d.ts

@@ -0,0 +1,102 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Represents a path through a tree of objects.
+ * number values represent array indices whereas string values represent object keys.
+ *
+ * @alpha
+ */
+export type ObjectPath = (string | number)[];
+/**
+ * Represents a create operation between two branches of a tree.
+ * Meaning that an attribute (a shared tree node) was identified as being created.
+ *
+ * @alpha
+ */
+export interface DifferenceCreate {
+    type: "CREATE";
+    path: ObjectPath;
+    value: unknown;
+}
+/**
+ * Represents a remove operation between two branches of a tree.
+ * Meaning that an attribute (a shared tree node) was identified as being deleted.
+ * When using object ids, removes are idenitified by an object with a given id no longer existing.
+ *
+ * @alpha
+ */
+export interface DifferenceRemove {
+    type: "REMOVE";
+    path: ObjectPath;
+    oldValue: unknown;
+    objectId?: string | number | undefined;
+}
+/**
+ * Represents a change operation between two branches of a tree.
+ * Meaning that an attribute (a shared tree node) was identified as being changed from one value to another.
+ *
+ * @alpha
+ */
+export interface DifferenceChange {
+    type: "CHANGE";
+    path: ObjectPath;
+    value: unknown;
+    oldValue: unknown;
+    objectId?: string | number | undefined;
+}
+/**
+ * Represents a move operation between two branches of a tree.
+ * Meaning that an object (shared tree node) was identified as being moved from one index to another based on its unique id.
+ *
+ * @alpha
+ */
+export interface DifferenceMove {
+    type: "MOVE";
+    path: ObjectPath;
+    newIndex: number;
+    value: unknown;
+    objectId?: string | number | undefined;
+}
+/**
+ * Union for all possible difference types.
+ *
+ * @alpha
+ */
+export type Difference = DifferenceCreate | DifferenceRemove | DifferenceChange | DifferenceMove;
+/**
+ * Options for tree diffing.
+ * @alpha
+ */
+export interface Options {
+    cyclesFix: boolean;
+    useObjectIds?: {
+        idAttributeName: string;
+    } | undefined;
+}
+/**
+ * Compares two objects and returns an array of differences between them.
+ *
+ * @alpha
+ */
+export declare function sharedTreeDiff(obj: Record<string, unknown> | unknown[], newObj: Record<string, unknown> | unknown[], options?: Options, _stack?: (Record<string, unknown> | unknown[])[]): Difference[];
+/**
+ * Creates a set of mergeable diffs from a series of diffs produced by {@link sharedTreeDiff}
+ * that are using the object ID strategy. These diffs don't need any modifications to be applied to the old object.
+ *
+ * @alpha
+ */
+export declare function createMergableIdDiffSeries(oldObject: unknown, diffs: Difference[], idAttributeName: string | number): Difference[];
+/**
+ * Creates a set of mergeable diffs from a series of diffs produced by {@link sharedTreeDiff}
+ * that AREN'T using the object ID strategy. These diffs don't need any modifications to be applied to the old object.
+ *
+ * @alpha
+ */
+export declare function createMergableDiffSeries(diffs: Difference[]): Difference[];
+/**
+ * Determines if a given difference is on an array.
+ */
+export declare function isDiffOnArray(diff: Difference): boolean;
+//# sourceMappingURL=sharedTreeDiff.d.ts.map

package/lib/implicit-strategy/sharedTreeDiff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeDiff.d.ts","sourceRoot":"","sources":["../../src/implicit-strategy/sharedTreeDiff.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GACnB,gBAAgB,GAChB,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,CAAC;AAElB;;;GAGG;AACH,MAAM,WAAW,OAAO;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EACV;QACA,eAAe,EAAE,MAAM,CAAC;KACvB,GACD,SAAS,CAAC;CACb;AAUD;;;;GAIG;AACH,wBAAgB,cAAc,CAC7B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,EACxC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,EAC3C,OAAO,GAAE,OAAyB,EAClC,MAAM,GAAE,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,CAAC,EAAO,GAClD,UAAU,EAAE,CA4Td;AAsCD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACzC,SAAS,EAAE,OAAO,EAClB,KAAK,EAAE,UAAU,EAAE,EACnB,eAAe,EAAE,MAAM,GAAG,MAAM,GAC9B,UAAU,EAAE,CA2Md;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CAkB1E;AASD;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAEvD"}