Add version property to Python and JavaScript documents (#139)

Author: davidbrochart

javascript/src/api.ts

@@ -85,6 +85,11 @@ export interface ISharedBase extends IObservableDisposable {
  * This is used by, for example, docregistry to share the file-path of the edited content.
  */
 export interface ISharedDocument extends ISharedBase {
+  /**
+   * Document version
+   */
+  readonly version: string;
+
   /**
    * Document state
    */

javascript/src/ydocument.ts

@@ -12,7 +12,9 @@ import type { DocumentChange, ISharedDocument, StateChange } from './api.js';
 /**
  * Generic shareable document.
  */
-export class YDocument<T extends DocumentChange> implements ISharedDocument {
+export abstract class YDocument<T extends DocumentChange>
+  implements ISharedDocument
+{
   constructor(options?: YDocument.IOptions) {
     this._ydoc = options?.ydoc ?? new Y.Doc();
 
@@ -29,11 +31,9 @@ export class YDocument<T extends DocumentChange> implements ISharedDocument {
   }
 
   /**
-   * Creates a standalone YDocument
+   * Document version
    */
-  static create(): YDocument<DocumentChange> {
-    return new YDocument();
-  }
+  abstract readonly version: string;
 
   /**
    * YJS document.

javascript/src/yfile.ts

@@ -27,6 +27,11 @@ export class YFile
     this.ysource.observe(this._modelObserver);
   }
 
+  /**
+   * Document version
+   */
+  readonly version: string = '1.0.0';
+
   /**
    * Creates a standalone YFile
    */

javascript/src/ynotebook.ts

@@ -66,6 +66,11 @@ export class YNotebook
     this.ymeta.observeDeep(this._onMetaChanged);
   }
 
+  /**
+   * Document version
+   */
+  readonly version: string = '1.0.0';
+
   /**
    * Creates a standalone YNotebook
    *

jupyter_ydoc/ybasedoc.py

@@ -29,6 +29,16 @@ def __init__(self, ydoc: Optional[Y.YDoc] = None):
         self._ystate = self._ydoc.get_map("state")
         self._subscriptions = {}
 
+    @property
+    @abstractmethod
+    def version(self) -> str:
+        """
+        Returns the version of the document.
+
+        :return: Document's version.
+        :rtype: str
+        """
+
     @property
     def ystate(self) -> Y.YMap:
         """

jupyter_ydoc/yblob.py

@@ -38,6 +38,16 @@ def __init__(self, ydoc: Optional[Y.YDoc] = None):
         super().__init__(ydoc)
         self._ysource = self._ydoc.get_map("source")
 
+    @property
+    def version(self) -> str:
+        """
+        Returns the version of the document.
+
+        :return: Document's version.
+        :rtype: str
+        """
+        return "1.0.0"
+
     def get(self) -> bytes:
         """
         Returns the content of the document.

jupyter_ydoc/ynotebook.py

@@ -58,6 +58,16 @@ def __init__(self, ydoc: Optional[Y.YDoc] = None):
         self._ymeta = self._ydoc.get_map("meta")
         self._ycells = self._ydoc.get_array("cells")
 
+    @property
+    def version(self) -> str:
+        """
+        Returns the version of the document.
+
+        :return: Document's version.
+        :rtype: str
+        """
+        return "1.0.0"
+
     @property
     def ycells(self):
         """

jupyter_ydoc/yunicode.py

@@ -33,6 +33,16 @@ def __init__(self, ydoc: Optional[Y.YDoc] = None):
         super().__init__(ydoc)
         self._ysource = self._ydoc.get_text("source")
 
+    @property
+    def version(self) -> str:
+        """
+        Returns the version of the document.
+
+        :return: Document's version.
+        :rtype: str
+        """
+        return "1.0.0"
+
     def get(self) -> str:
         """
         Returns the content of the document.