v13.0.0-47 -- distribution files

examples/html-editor/index.js

@@ -4,14 +4,14 @@ window.onload = function () {
   window.yXmlType.bindToDom(document.body)
 }
 
-let persistence = null //  new Y.IndexedDBPersistence()
+const persistence = new Y.IndexedDB()
 
 // initialize a shared object. This function call returns a promise!
-let y = new Y({
+let y = new Y('htmleditor', {
   connector: {
     name: 'websockets-client',
     url: 'http://127.0.0.1:1234',
-    room: 'x'
+    room: 'html-editor'
     // maxBufferLength: 100
   }
 }, persistence)

examples/indexeddb/index.js

@@ -1,24 +1,18 @@
 /* global Y, CodeMirror */
 
-// initialize a shared object. This function call returns a promise!
-Y({
-  db: {
-    name: 'memory'
-  },
+const persistence = new Y.IndexedDB()
+const connector = {
   connector: {
     name: 'websockets-client',
     room: 'codemirror-example'
-  },
-  sourceDir: '/bower_components',
-  share: {
-    codemirror: 'Text' // y.share.codemirror is of type Y.Text
   }
-}).then(function (y) {
-  window.yCodeMirror = y
+}
+// initialize a shared object. This function call returns a promise!
+const y = Y('codemirror-example', connector, persistence)
+window.yCodeMirror = y
 
-  var editor = CodeMirror(document.querySelector('#codeMirrorContainer'), {
-    mode: 'javascript',
-    lineNumbers: true
-  })
-  y.share.codemirror.bindCodeMirror(editor)
+var editor = CodeMirror(document.querySelector('#codeMirrorContainer'), {
+  mode: 'javascript',
+  lineNumbers: true
 })
+y.share.codemirror.bindCodeMirror(editor)

examples/yjs-dist.mjs

@@ -1,9 +1,9 @@
 
 import Y from '../src/Y.js'
 import yWebsocketsClient from '../../y-websockets-client/src/y-websockets-client.js'
-import IndexedDBPersistence from '../../y-indexeddb/src/y-indexeddb.js'
+import extendYIndexedDBPersistence from '../../y-indexeddb/src/y-indexeddb.js'
 
 Y.extend(yWebsocketsClient)
-Y.IndexedDBPersistence = IndexedDBPersistence
+extendYIndexedDBPersistence(Y)
 
 export default Y

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "yjs",
-  "version": "13.0.0-46",
+  "version": "13.0.0-47",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yjs",
-  "version": "13.0.0-46",
+  "version": "13.0.0-47",
   "description": "A framework for real-time p2p shared editing on any data",
   "main": "./y.node.js",
   "browser": "./y.js",

src/Persistence.js

@@ -25,32 +25,55 @@ export default class AbstractPersistence {
     if (cnf === undefined) {
       cnf = getFreshCnf()
       this.ys.set(y, cnf)
-      this.init(y)
-      y.on('afterTransaction', (y, transaction) => {
-        let cnf = this.ys.get(y)
-        if (cnf.len > 0) {
-          cnf.buffer.setUint32(0, cnf.len)
-          this.saveUpdate(y, cnf.buffer.createBuffer(), transaction)
-          let _cnf = getFreshCnf()
-          for (let key in _cnf) {
-            cnf[key] = _cnf[key]
+      return this.init(y).then(() => {
+        y.on('afterTransaction', (y, transaction) => {
+          let cnf = this.ys.get(y)
+          if (cnf.len > 0) {
+            cnf.buffer.setUint32(0, cnf.len)
+            this.saveUpdate(y, cnf.buffer.createBuffer(), transaction)
+            let _cnf = getFreshCnf()
+            for (let key in _cnf) {
+              cnf[key] = _cnf[key]
+            }
           }
-        }
+        })
+        return this.retrieve(y)
+      }).then(function () {
+        return Promise.resolve(cnf)
       })
-    }
-    return this.retrieve(y).then(function () {
+    } else {
       return Promise.resolve(cnf)
-    })
+    }
   }
-
   deinit (y) {
     this.ys.delete(y)
+    y.persistence = null
   }
 
   destroy () {
     this.ys = null
   }
 
+  /**
+   * Remove all persisted data that belongs to a room.
+   * Automatically destroys all Yjs all Yjs instances that persist to
+   * the room. If `destroyYjsInstances = false` the persistence functionality
+   * will be removed from the Yjs instances.
+   *
+   * ** Must be overwritten! **
+   */
+  removePersistedData (room, destroyYjsInstances = true) {
+    this.ys.forEach((cnf, y) => {
+      if (y.room === room) {
+        if (destroyYjsInstances) {
+          y.destroy()
+        } else {
+          this.deinit(y)
+        }
+      }
+    })
+  }
+
   /* overwrite */
   saveUpdate (buffer) {
   }
@@ -75,17 +98,17 @@ export default class AbstractPersistence {
       y.transact(function () {
         if (model != null) {
           fromBinary(y, new BinaryDecoder(new Uint8Array(model)))
-          y._setContentReady()
         }
         if (updates != null) {
           for (let i = 0; i < updates.length; i++) {
             integrateRemoteStructs(y, new BinaryDecoder(new Uint8Array(updates[i])))
-            y._setContentReady()
           }
         }
       })
+      y.emit('persistenceReady')
     })
   }
+
   /* overwrite */
   persist (y) {
     return toBinary(y).createBuffer()

src/Util/NamedEventHandler.js

@@ -1,6 +1,7 @@
 export default class NamedEventHandler {
   constructor () {
     this._eventListener = new Map()
+    this._stateListener = new Map()
   }
   _getListener (name) {
     let listeners = this._eventListener.get(name)
@@ -21,6 +22,20 @@ export default class NamedEventHandler {
     let listeners = this._getListener(name)
     listeners.on.add(f)
   }
+  _initStateListener (name) {
+    let state = this._stateListener.get(name)
+    if (state === undefined) {
+      state = {}
+      state.promise = new Promise(function (resolve) {
+        state.resolve = resolve
+      })
+      this._stateListener.set(name, state)
+    }
+    return state
+  }
+  when (name) {
+    return this._initStateListener(name).promise
+  }
   off (name, f) {
     if (name == null || f == null) {
       throw new Error('You must specify event name and function!')
@@ -32,6 +47,7 @@ export default class NamedEventHandler {
     }
   }
   emit (name, ...args) {
+    this._initStateListener(name).resolve()
     const listener = this._eventListener.get(name)
     if (listener !== undefined) {
       listener.on.forEach(f => f.apply(null, args))

src/Y.js

@@ -5,6 +5,7 @@ import { generateUserID } from './Util/generateUserID.js'
 import RootID from './Util/RootID.js'
 import NamedEventHandler from './Util/NamedEventHandler.js'
 import UndoManager from './Util/UndoManager.js'
+import { integrateRemoteStructs } from './MessageHandler/integrateRemoteStructs.js'
 
 import { messageToString, messageToRoomname } from './MessageHandler/messageToString.js'
 
@@ -61,6 +62,15 @@ export default class Y extends NamedEventHandler {
       this.emit('content')
     }
   }
+  whenContentReady () {
+    if (this._contentReady) {
+      return Promise.resolve()
+    } else {
+      return new Promise(resolve => {
+        this.once('content', resolve)
+      })
+    }
+  }
   _beforeChange () {}
   transact (f, remote = false) {
     let initialCall = this._transaction === null
@@ -192,7 +202,8 @@ Y.utils = {
   UndoManager,
   getRelativePosition,
   fromRelativePosition,
-  addType
+  addType,
+  integrateRemoteStructs
 }
 
 Y.debug = debug

y.node.js

@@ -1,7 +1,7 @@
 
 /**
  * yjs - A framework for real-time p2p shared editing on any data
- * @version v13.0.0-46
+ * @version v13.0.0-47
  * @license MIT
  */
 
@@ -3591,6 +3591,7 @@ function generateUserID () {
 class NamedEventHandler {
   constructor () {
     this._eventListener = new Map();
+    this._stateListener = new Map();
   }
   _getListener (name) {
     let listeners = this._eventListener.get(name);
@@ -3611,6 +3612,20 @@ class NamedEventHandler {
     let listeners = this._getListener(name);
     listeners.on.add(f);
   }
+  _initStateListener (name) {
+    let state = this._stateListener.get(name);
+    if (state === undefined) {
+      state = {};
+      state.promise = new Promise(function (resolve) {
+        state.resolve = resolve;
+      });
+      this._stateListener.set(name, state);
+    }
+    return state
+  }
+  when (name) {
+    return this._initStateListener(name).promise
+  }
   off (name, f) {
     if (name == null || f == null) {
       throw new Error('You must specify event name and function!')
@@ -3622,6 +3637,7 @@ class NamedEventHandler {
     }
   }
   emit (name, ...args) {
+    this._initStateListener(name).resolve();
     const listener = this._eventListener.get(name);
     if (listener !== undefined) {
       listener.on.forEach(f => f.apply(null, args));
@@ -4642,32 +4658,55 @@ class AbstractPersistence {
     if (cnf === undefined) {
       cnf = getFreshCnf();
       this.ys.set(y, cnf);
-      this.init(y);
-      y.on('afterTransaction', (y, transaction) => {
-        let cnf = this.ys.get(y);
-        if (cnf.len > 0) {
-          cnf.buffer.setUint32(0, cnf.len);
-          this.saveUpdate(y, cnf.buffer.createBuffer(), transaction);
-          let _cnf = getFreshCnf();
-          for (let key in _cnf) {
-            cnf[key] = _cnf[key];
+      return this.init(y).then(() => {
+        y.on('afterTransaction', (y, transaction) => {
+          let cnf = this.ys.get(y);
+          if (cnf.len > 0) {
+            cnf.buffer.setUint32(0, cnf.len);
+            this.saveUpdate(y, cnf.buffer.createBuffer(), transaction);
+            let _cnf = getFreshCnf();
+            for (let key in _cnf) {
+              cnf[key] = _cnf[key];
+            }
           }
-        }
-      });
-    }
-    return this.retrieve(y).then(function () {
+        });
+        return this.retrieve(y)
+      }).then(function () {
+        return Promise.resolve(cnf)
+      })
+    } else {
       return Promise.resolve(cnf)
-    })
+    }
   }
-
   deinit (y) {
     this.ys.delete(y);
+    y.persistence = null;
   }
 
   destroy () {
     this.ys = null;
   }
 
+  /**
+   * Remove all persisted data that belongs to a room.
+   * Automatically destroys all Yjs all Yjs instances that persist to
+   * the room. If `destroyYjsInstances = false` the persistence functionality
+   * will be removed from the Yjs instances.
+   *
+   * ** Must be overwritten! **
+   */
+  removePersistedData (room, destroyYjsInstances = true) {
+    this.ys.forEach((cnf, y) => {
+      if (y.room === room) {
+        if (destroyYjsInstances) {
+          y.destroy();
+        } else {
+          this.deinit(y);
+        }
+      }
+    });
+  }
+
   /* overwrite */
   saveUpdate (buffer) {
   }
@@ -4692,17 +4731,17 @@ class AbstractPersistence {
       y.transact(function () {
         if (model != null) {
           fromBinary(y, new BinaryDecoder(new Uint8Array(model)));
-          y._setContentReady();
         }
         if (updates != null) {
           for (let i = 0; i < updates.length; i++) {
             integrateRemoteStructs(y, new BinaryDecoder(new Uint8Array(updates[i])));
-            y._setContentReady();
           }
         }
       });
+      y.emit('persistenceReady');
     });
   }
+
   /* overwrite */
   persist (y) {
     return toBinary(y).createBuffer()
@@ -4749,6 +4788,15 @@ class Y$1 extends NamedEventHandler {
       this.emit('content');
     }
   }
+  whenContentReady () {
+    if (this._contentReady) {
+      return Promise.resolve()
+    } else {
+      return new Promise(resolve => {
+        this.once('content', resolve);
+      })
+    }
+  }
   _beforeChange () {}
   transact (f, remote = false) {
     let initialCall = this._transaction === null;
@@ -4880,7 +4928,8 @@ Y$1.utils = {
   UndoManager,
   getRelativePosition,
   fromRelativePosition,
-  addType: addStruct
+  addType: addStruct,
+  integrateRemoteStructs
 };
 
 Y$1.debug = browser;