Add forkID document attribute

jupyter-server · Feb 27, 2024 · 20be1d2 · 20be1d2
1 parent 83681d6
commit 20be1d2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/javascript/src/api.ts b/javascript/src/api.ts
@@ -156,6 +156,11 @@ export interface ISharedDocument extends ISharedBase {
    * @param forkId The fork ID to add to the document
    */
   addFork(forkId: string): void;
+
+  /**
+   * The document fork ID
+   */
+  forkId: string;
 }
 
 /**

diff --git a/javascript/src/ydocument.ts b/javascript/src/ydocument.ts
@@ -17,6 +17,7 @@ export abstract class YDocument<T extends DocumentChange>
 {
   constructor(options?: YDocument.IOptions) {
     this._ydoc = options?.ydoc ?? new Y.Doc();
+    this.forkId = options?.forkId ?? 'root';
 
     this._ystate = this._ydoc.getMap('state');
 
@@ -225,6 +226,7 @@ export abstract class YDocument<T extends DocumentChange>
   private _isDisposed = false;
   private _disposed = new Signal<this, void>(this);
   private _providers: { [key: string]: IDocumentProvider };
+  public forkId: string;
 }
 
 /**
@@ -239,5 +241,10 @@ export namespace YDocument {
      * The optional YJS document for YDocument.
      */
     ydoc?: Y.Doc;
+
+    /**
+     * The document fork ID, defaults to 'root'.
+     */
+    forkId?: string;
   }
 }