Return new heads from DocHandle.changeAt

automerge · Sep 12, 2023 · 5881dc4 · 5881dc4
1 parent eb59ad3
commit 5881dc4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/packages/automerge-repo/src/DocHandle.ts b/packages/automerge-repo/src/DocHandle.ts
@@ -326,23 +326,31 @@ export class DocHandle<T> //
     })
   }
 
+  /** Make a change as if the document were at `heads`
+   *
+   * @returns A set of heads representing the concurrent change that was made.
+   */
   changeAt(
     heads: A.Heads,
     callback: A.ChangeFn<T>,
     options: A.ChangeOptions<T> = {}
-  ) {
+  ): string[] | undefined {
     if (!this.isReady()) {
       throw new Error(
         `DocHandle#${this.documentId} is not ready. Check \`handle.isReady()\` before accessing the document.`
       )
     }
+    let resultHeads: string[] | undefined = undefined
     this.#machine.send(UPDATE, {
       payload: {
         callback: (doc: A.Doc<T>) => {
-          return A.changeAt(doc, heads, options, callback).newDoc
+          const result = A.changeAt(doc, heads, options, callback)
+          resultHeads = result.newHeads
+          return result.newDoc
         },
       },
     })
+    return resultHeads
   }
 
   unavailable() {

diff --git a/packages/automerge-repo/test/DocHandle.test.ts b/packages/automerge-repo/test/DocHandle.test.ts
@@ -295,10 +295,11 @@ describe("DocHandle", () => {
     })
 
     let wasBar = false
-    handle.changeAt(headsBefore, doc => {
+    let newHeads = handle.changeAt(headsBefore, doc => {
       wasBar = doc.foo === "bar"
       doc.foo = "baz"
     })
+    assert(newHeads && newHeads.length > 0, "should have new heads")
 
     assert(wasBar, "foo should have been bar as we changed at the old heads")
   })