Add YDocument source getter/setter (#273)

Author: davidbrochart

javascript/src/api.ts

@@ -85,7 +85,7 @@ export interface ISharedBase extends IObservableDisposable {
  * Implement an API for Context information on the shared information.
  * This is used by, for example, docregistry to share the file-path of the edited content.
  */
-export interface ISharedDocument extends ISharedBase {
+interface ISharedDocumentNoSource extends ISharedBase {
   /**
    * Document version
    */
@@ -117,6 +117,26 @@ export interface ISharedDocument extends ISharedBase {
   readonly changed: ISignal<this, DocumentChange>;
 }
 
+/**
+ * Implement an API for Context information on the shared information.
+ * This is used by, for example, docregistry to share the file-path of the edited content.
+ */
+export interface ISharedDocument extends ISharedDocumentNoSource {
+  /**
+   * Get the document source.
+   *
+   * @returns Source.
+   */
+  getSource(): string | JSONValue;
+
+  /**
+   * Set the document source.
+   *
+   * @param value New source.
+   */
+  setSource(value: string | JSONValue): void;
+}
+
 /**
  * The ISharedText interface defines models that can be bound to a text editor like CodeMirror.
  */
@@ -158,7 +178,7 @@ export interface ISharedText extends ISharedBase {
 /**
  * Text/Markdown/Code files are represented as ISharedFile
  */
-export interface ISharedFile extends ISharedDocument, ISharedText {
+export interface ISharedFile extends ISharedDocumentNoSource, ISharedText {
   /**
    * The changed signal.
    */

javascript/src/ydocument.ts

@@ -145,6 +145,38 @@ export abstract class YDocument<T extends DocumentChange>
     }
   }
 
+  /**
+   * Get the document source
+   *
+   * @returns The source
+   */
+  get source(): JSONValue | string {
+    return this.getSource();
+  }
+
+  /**
+   * Set the document source
+   *
+   * @param value The source to set
+   */
+  set source(value: JSONValue | string) {
+    this.setSource(value);
+  }
+
+  /**
+   * Get the document source
+   *
+   * @returns The source
+   */
+  abstract getSource(): JSONValue | string;
+
+  /**
+   * Set the document source
+   *
+   * @param value The source to set
+   */
+  abstract setSource(value: JSONValue | string): void;
+
   /**
    * Undo an operation.
    */

javascript/src/ynotebook.ts

@@ -4,7 +4,7 @@
 |----------------------------------------------------------------------------*/
 
 import type * as nbformat from '@jupyterlab/nbformat';
-import { JSONExt, PartialJSONValue } from '@lumino/coreutils';
+import { JSONExt, JSONValue, PartialJSONValue } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import * as Y from 'yjs';
 import type {
@@ -404,6 +404,24 @@ export class YNotebook
     });
   }
 
+  /**
+   * Get the notebook source
+   *
+   * @returns The notebook
+   */
+  getSource(): JSONValue {
+    return this.toJSON() as JSONValue;
+  }
+
+  /**
+   * Set the notebook source
+   *
+   * @param value The notebook
+   */
+  setSource(value: JSONValue): void {
+    this.fromJSON(value as nbformat.INotebookContent);
+  }
+
   /**
    * Override the notebook with a JSON-serialized document.
    *