v13.0.0-30 -- distribution files

examples/html-editor/index.js

@@ -1,4 +1,15 @@
-/* global Y */
+/* global Y, HTMLElement, customElements */
+
+class MagicTable extends HTMLElement {
+  constructor () {
+    super()
+    var shadow = this.attachShadow({mode: 'open'})
+    setTimeout(() => {
+      shadow.append(this.childNodes[0])
+    }, 1000)
+  }
+}
+customElements.define('magic-table', MagicTable)
 
 // initialize a shared object. This function call returns a promise!
 let y = new Y({
@@ -17,16 +28,14 @@ window.onload = function () {
   window.yXmlType.bindToDom(document.body)
 }
 window.undoManager = new Y.utils.UndoManager(window.yXmlType, {
-  captureTimeout: 1000
+  captureTimeout: 500
 })
 
 document.onkeydown = function interceptUndoRedo (e) {
-  if (e.keyCode === 90 && e.ctrlKey) {
+  if (e.keyCode === 90 && e.metaKey) {
     if (!e.shiftKey) {
-      console.info('Undo!')
       window.undoManager.undo()
     } else {
-      console.info('Redo!')
       window.undoManager.redo()
     }
     e.preventDefault()

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "yjs",
-  "version": "13.0.0-25",
+  "version": "13.0.0-30",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2808,14 +2808,6 @@
             }
           }
         },
-        "string_decoder": {
-          "version": "1.0.1",
-          "bundled": true,
-          "dev": true,
-          "requires": {
-            "safe-buffer": "5.0.1"
-          }
-        },
         "string-width": {
           "version": "1.0.2",
           "bundled": true,
@@ -2826,6 +2818,14 @@
             "strip-ansi": "3.0.1"
           }
         },
+        "string_decoder": {
+          "version": "1.0.1",
+          "bundled": true,
+          "dev": true,
+          "requires": {
+            "safe-buffer": "5.0.1"
+          }
+        },
         "stringstream": {
           "version": "0.0.5",
           "bundled": true,
@@ -4868,15 +4868,6 @@
         "duplexer": "0.1.1"
       }
     },
-    "string_decoder": {
-      "version": "1.0.3",
-      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
-      "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
-      "dev": true,
-      "requires": {
-        "safe-buffer": "5.1.1"
-      }
-    },
     "string-width": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz",
@@ -4898,6 +4889,15 @@
       "resolved": "https://registry.npmjs.org/string.prototype.codepointat/-/string.prototype.codepointat-0.2.0.tgz",
       "integrity": "sha1-aybpvTr8qnvjtCabUm3huCAArHg="
     },
+    "string_decoder": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
+      "integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
+      "dev": true,
+      "requires": {
+        "safe-buffer": "5.1.1"
+      }
+    },
     "strip-ansi": {
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz",

package.json

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

rollup.browser.js

@@ -5,9 +5,13 @@ import commonjs from 'rollup-plugin-commonjs'
 var pkg = require('./package.json')
 
 export default {
-  entry: 'src/Y.js',
+  input: 'src/Y.js',
-  moduleName: 'Y',
+  name: 'Y',
-  format: 'umd',
+  sourcemap: true,
+  output: {
+    file: 'y.js',
+    format: 'umd'
+  },
   plugins: [
     nodeResolve({
       main: true,
@@ -32,8 +36,6 @@ export default {
       }
     })
   ],
-  dest: 'y.js',
-  sourceMap: true,
   banner: `
 /**
  * ${pkg.name} - ${pkg.description}

rollup.node.js

@@ -3,9 +3,13 @@ import commonjs from 'rollup-plugin-commonjs'
 var pkg = require('./package.json')
 
 export default {
-  entry: 'src/y-dist.cjs.js',
+  input: 'src/y-dist.cjs.js',
-  moduleName: 'Y',
+  nameame: 'Y',
-  format: 'cjs',
+  sourcemap: true,
+  output: {
+    file: 'y.node.js',
+    format: 'cjs'
+  },
   plugins: [
     nodeResolve({
       main: true,
@@ -14,8 +18,6 @@ export default {
     }),
     commonjs()
   ],
-  dest: 'y.node.js',
-  sourceMap: true,
   banner: `
 /**
  * ${pkg.name} - ${pkg.description}

rollup.test.js

@@ -3,9 +3,13 @@ import commonjs from 'rollup-plugin-commonjs'
 import multiEntry from 'rollup-plugin-multi-entry'
 
 export default {
-  entry: 'test/y-xml.tests.js',
+  input: 'test/y-xml.tests.js',
-  moduleName: 'y-tests',
+  name: 'y-tests',
-  format: 'umd',
+  sourcemap: true,
+  output: {
+    file: 'y.test.js',
+    format: 'umd'
+  },
   plugins: [
     nodeResolve({
       main: true,
@@ -14,7 +18,5 @@ export default {
     }),
     commonjs(),
     multiEntry()
-  ],
+  ]
-  dest: 'y.test.js',
-  sourceMap: true
 }

src/Struct/ItemJSON.js

@@ -20,7 +20,13 @@ export default class ItemJSON extends Item {
     this._content = new Array(len)
     for (let i = 0; i < len; i++) {
       const ctnt = decoder.readVarString()
-      this._content[i] = JSON.parse(ctnt)
+      let parsed
+      if (ctnt === 'undefined') {
+        parsed = undefined
+      } else {
+        parsed = JSON.parse(ctnt)
+      }
+      this._content[i] = parsed
     }
     return missing
   }
@@ -29,7 +35,14 @@ export default class ItemJSON extends Item {
     let len = this._content.length
     encoder.writeVarUint(len)
     for (let i = 0; i < len; i++) {
-      encoder.writeVarString(JSON.stringify(this._content[i]))
+      let encoded
+      let content = this._content[i]
+      if (content === undefined) {
+        encoded = 'undefined'
+      } else {
+        encoded = JSON.stringify(content)
+      }
+      encoder.writeVarString(encoded)
     }
   }
   _logString () {

src/Struct/Type.js

@@ -65,9 +65,9 @@ export default class Type extends Item {
     }
     return path
   }
-  _callEventHandler (event) {
+  _callEventHandler (transaction, event) {
-    const changedParentTypes = this._y._transaction.changedParentTypes
+    const changedParentTypes = transaction.changedParentTypes
-    this._eventHandler.callEventListeners(event)
+    this._eventHandler.callEventListeners(transaction, event)
     let type = this
     while (type !== this._y) {
       let events = changedParentTypes.get(type)

src/Type/YArray.js

@@ -1,5 +1,6 @@
 import Type from '../Struct/Type.js'
 import ItemJSON from '../Struct/ItemJSON.js'
+import ItemString from '../Struct/ItemString.js'
 import { logID } from '../MessageHandler/messageToString.js'
 import YEvent from '../Util/YEvent.js'
 
@@ -11,15 +12,19 @@ class YArrayEvent extends YEvent {
 }
 
 export default class YArray extends Type {
-  _callObserver (parentSubs, remote) {
+  _callObserver (transaction, parentSubs, remote) {
-    this._callEventHandler(new YArrayEvent(this, remote))
+    this._callEventHandler(transaction, new YArrayEvent(this, remote))
   }
   get (pos) {
     let n = this._start
     while (n !== null) {
       if (!n._deleted) {
         if (pos < n._length) {
-          return n._content[n._length - pos]
+          if (n.constructor === ItemJSON || n.constructor === ItemString) {
+            return n._content[pos]
+          } else {
+            return n
+          }
         }
         pos -= n._length
       }

src/Type/YMap.js

@@ -13,8 +13,8 @@ class YMapEvent extends YEvent {
 }
 
 export default class YMap extends Type {
-  _callObserver (parentSubs, remote) {
+  _callObserver (transaction, parentSubs, remote) {
-    this._callEventHandler(new YMapEvent(this, parentSubs, remote))
+    this._callEventHandler(transaction, new YMapEvent(this, parentSubs, remote))
   }
   toJSON () {
     const map = {}

src/Type/y-xml/YXmlFragment.js

@@ -142,8 +142,8 @@ export default class YXmlFragment extends YArray {
       xml.setDomFilter(f)
     })
   }
-  _callObserver (parentSubs, remote) {
+  _callObserver (transaction, parentSubs, remote) {
-    this._callEventHandler(new YXmlEvent(this, parentSubs, remote))
+    this._callEventHandler(transaction, new YXmlEvent(this, parentSubs, remote))
   }
   toString () {
     return this.map(xml => xml.toString()).join('')
@@ -255,7 +255,7 @@ export default class YXmlFragment extends YArray {
             }
           })
           for (let dom of diffChildren) {
-            if (dom._yxml != null) {
+            if (dom._yxml != null && dom._yxml !== false) {
               applyChangesFromDom(dom)
             }
           }

src/Type/y-xml/selection.js

@@ -7,7 +7,7 @@ let relativeSelection = null
 
 export let beforeTransactionSelectionFixer
 if (typeof getSelection !== 'undefined') {
-  beforeTransactionSelectionFixer = function _beforeTransactionSelectionFixer (y, remote) {
+  beforeTransactionSelectionFixer = function _beforeTransactionSelectionFixer (y, transaction, remote) {
     if (!remote) {
       return
     }
@@ -30,7 +30,7 @@ if (typeof getSelection !== 'undefined') {
   beforeTransactionSelectionFixer = function _fakeBeforeTransactionSelectionFixer () {}
 }
 
-export function afterTransactionSelectionFixer (y, remote) {
+export function afterTransactionSelectionFixer (y, transaction, remote) {
   if (relativeSelection === null || !remote) {
     return
   }

src/Type/y-xml/utils.js

@@ -136,6 +136,32 @@ export function applyChangesFromDom (dom) {
 }
 
 export function reflectChangesOnDom (events) {
+  // Make sure that no filtered attributes are applied to the structure
+  // if they were, delete them
+  /*
+  events.forEach(event => {
+    const target = event.target
+    if (event.attributesChanged === undefined) {
+      // event.target is Y.XmlText
+      return
+    }
+    const keys = this._domFilter(target.nodeName, Array.from(event.attributesChanged))
+    if (keys === null) {
+      target._delete()
+    } else {
+      const removeKeys = new Set() // is a copy of event.attributesChanged
+      event.attributesChanged.forEach(key => { removeKeys.add(key) })
+      keys.forEach(key => {
+        // remove all accepted keys from removeKeys
+        removeKeys.delete(key)
+      })
+      // remove the filtered attribute
+      removeKeys.forEach(key => {
+        target.removeAttribute(key)
+      })
+    }
+  })
+  */
   this._mutualExclude(() => {
     events.forEach(event => {
       const yxml = event.target

src/Util/EventHandler.js

@@ -17,7 +17,7 @@ export default class EventHandler {
   removeAllEventListeners () {
     this.eventListeners = []
   }
-  callEventListeners (event) {
+  callEventListeners (transaction, event) {
     for (var i = 0; i < this.eventListeners.length; i++) {
       try {
         const f = this.eventListeners[i]

src/Util/UndoManager.js

@@ -1,16 +1,16 @@
 import ID from './ID.js'
 
 class ReverseOperation {
-  constructor (y) {
+  constructor (y, transaction) {
     this.created = new Date()
-    const beforeState = y._transaction.beforeState
+    const beforeState = transaction.beforeState
     this.toState = new ID(y.userID, y.ss.getState(y.userID) - 1)
     if (beforeState.has(y.userID)) {
       this.fromState = new ID(y.userID, beforeState.get(y.userID))
     } else {
       this.fromState = this.toState
     }
-    this.deletedStructs = y._transaction.deletedStructs
+    this.deletedStructs = transaction.deletedStructs
   }
 }
 
@@ -24,10 +24,45 @@ function isStructInScope (y, struct, scope) {
   return false
 }
 
+function applyReverseOperation (y, scope, reverseBuffer) {
+  let performedUndo = false
+  y.transact(() => {
+    while (!performedUndo && reverseBuffer.length > 0) {
+      let undoOp = reverseBuffer.pop()
+      // make sure that it is possible to iterate {from}-{to}
+      y.os.getItemCleanStart(undoOp.fromState)
+      y.os.getItemCleanEnd(undoOp.toState)
+      y.os.iterate(undoOp.fromState, undoOp.toState, op => {
+        if (!op._deleted && isStructInScope(y, op, scope)) {
+          performedUndo = true
+          op._delete(y)
+        }
+      })
+      for (let op of undoOp.deletedStructs) {
+        if (
+          isStructInScope(y, op, scope) &&
+          op._parent !== y &&
+          !op._parent._deleted &&
+          (
+            op._parent._id.user !== y.userID ||
+            op._parent._id.clock < undoOp.fromState.clock ||
+            op._parent._id.clock > undoOp.fromState.clock
+          )
+        ) {
+          performedUndo = true
+          op = op._copy(undoOp.deletedStructs)
+          op._integrate(y)
+        }
+      }
+    }
+  })
+  return performedUndo
+}
+
 export default class UndoManager {
   constructor (scope, options = {}) {
     this.options = options
-    options.captureTimeout = options.captureTimeout || 0
+    options.captureTimeout = options.captureTimeout == null ? 500 : options.captureTimeout
     this._undoBuffer = []
     this._redoBuffer = []
     this._scope = scope
@@ -35,13 +70,12 @@ export default class UndoManager {
     this._redoing = false
     const y = scope._y
     this.y = y
-    y.on('afterTransaction', (y, remote) => {
+    y.on('afterTransaction', (y, transaction, remote) => {
-      if (!remote && (y._transaction.beforeState.has(y.userID) || y._transaction.deletedStructs.size > 0)) {
+      if (!remote && transaction.changedParentTypes.has(scope)) {
-        let reverseOperation = new ReverseOperation(y)
+        let reverseOperation = new ReverseOperation(y, transaction)
         if (!this._undoing) {
           let lastUndoOp = this._undoBuffer.length > 0 ? this._undoBuffer[this._undoBuffer.length - 1] : null
-          if (lastUndoOp !== null && lastUndoOp.created - reverseOperation.created <= options.captureTimeout) {
+          if (lastUndoOp !== null && reverseOperation.created - lastUndoOp.created <= options.captureTimeout) {
-            console.log('appending', lastUndoOp, reverseOperation)
             lastUndoOp.created = reverseOperation.created
             lastUndoOp.toState = reverseOperation.toState
             reverseOperation.deletedStructs.forEach(lastUndoOp.deletedStructs.add, lastUndoOp.deletedStructs)
@@ -58,47 +92,15 @@ export default class UndoManager {
     })
   }
   undo () {
-    console.log('undoing')
     this._undoing = true
-    this._applyReverseOperation(this._undoBuffer)
+    const performedUndo = applyReverseOperation(this.y, this._scope, this._undoBuffer)
     this._undoing = false
+    return performedUndo
   }
   redo () {
     this._redoing = true
-    this._applyReverseOperation(this._redoBuffer)
+    const performedRedo = applyReverseOperation(this.y, this._scope, this._redoBuffer)
     this._redoing = false
-  }
+    return performedRedo
-  _applyReverseOperation (reverseBuffer) {
-    this.y.transact(() => {
-      let performedUndo = false
-      while (!performedUndo && reverseBuffer.length > 0) {
-        let undoOp = reverseBuffer.pop()
-        // make sure that it is possible to iterate {from}-{to}
-        this.y.os.getItemCleanStart(undoOp.fromState)
-        this.y.os.getItemCleanEnd(undoOp.toState)
-        this.y.os.iterate(undoOp.fromState, undoOp.toState, op => {
-          if (!op._deleted && isStructInScope(this.y, op, this._scope)) {
-            performedUndo = true
-            op._delete(this.y)
-          }
-        })
-        for (let op of undoOp.deletedStructs) {
-          if (
-            isStructInScope(this.y, op, this._scope) &&
-            op._parent !== this.y &&
-            !op._parent._deleted &&
-            (
-              op._parent._id.user !== this.y.userID ||
-              op._parent._id.clock < undoOp.fromState.clock ||
-              op._parent._id.clock > undoOp.fromState.clock
-            )
-          ) {
-            performedUndo = true
-            op = op._copy(undoOp.deletedStructs)
-            op._integrate(this.y)
-          }
-        }
-      }
-    })
   }
 }

src/Util/YEvent.js

@@ -8,15 +8,15 @@ export default class YEvent {
     const path = []
     let type = this.target
     const y = type._y
-    while (type._parent !== this._currentTarget && type._parent !== y) {
+    while (type !== this.currentTarget && type !== y) {
       let parent = type._parent
       if (type._parentSub !== null) {
-        path.push(type._parentSub)
+        path.unshift(type._parentSub)
       } else {
         // parent is array-ish
         for (let [i, child] of parent) {
           if (child === type) {
-            path.push(i)
+            path.unshift(i)
             break
           }
         }

src/Y.js

@@ -15,6 +15,7 @@ import YMap from './Type/YMap.js'
 import YText from './Type/YText.js'
 import { YXmlFragment, YXmlElement, YXmlText } from './Type/y-xml/y-xml.js'
 import BinaryDecoder from './Binary/Decoder.js'
+import { getRelativePosition, fromRelativePosition } from './Util/relativePosition.js'
 
 import debug from 'debug'
 import Transaction from './Transaction.js'
@@ -44,8 +45,8 @@ export default class Y extends NamedEventHandler {
   transact (f, remote = false) {
     let initialCall = this._transaction === null
     if (initialCall) {
-      this.emit('beforeTransaction', this, remote)
       this._transaction = new Transaction(this)
+      this.emit('beforeTransaction', this, this._transaction, remote)
     }
     try {
       f(this)
@@ -53,13 +54,15 @@ export default class Y extends NamedEventHandler {
       console.error(e)
     }
     if (initialCall) {
+      const transaction = this._transaction
+      this._transaction = null
       // emit change events on changed types
-      this._transaction.changedTypes.forEach(function (subs, type) {
+      transaction.changedTypes.forEach(function (subs, type) {
         if (!type._deleted) {
-          type._callObserver(subs, remote)
+          type._callObserver(transaction, subs, remote)
         }
       })
-      this._transaction.changedParentTypes.forEach(function (events, type) {
+      transaction.changedParentTypes.forEach(function (events, type) {
         if (!type._deleted) {
           events = events
             .filter(event =>
@@ -71,12 +74,11 @@ export default class Y extends NamedEventHandler {
             })
           // we don't have to check for events.length
           // because there is no way events is empty..
-          type._deepEventHandler.callEventListeners(events)
+          type._deepEventHandler.callEventListeners(transaction, events)
         }
       })
       // when all changes & events are processed, emit afterTransaction event
-      this.emit('afterTransaction', this, remote)
+      this.emit('afterTransaction', this, transaction, remote)
-      this._transaction = null
     }
   }
   // fake _start for root properties (y.set('name', type))
@@ -168,7 +170,9 @@ Y.XmlText = YXmlText
 
 Y.utils = {
   BinaryDecoder,
-  UndoManager
+  UndoManager,
+  getRelativePosition,
+  fromRelativePosition
 }
 
 Y.debug = debug

test/y-map.tests.js

@@ -41,6 +41,8 @@ test('basic map tests', async function map0 (t) {
 test('Basic get&set of Map property (converge via sync)', async function map1 (t) {
   let { users, map0 } = await initArrays(t, { users: 2 })
   map0.set('stuff', 'stuffy')
+  map0.set('undefined', undefined)
+  map0.set('null', null)
   t.compare(map0.get('stuff'), 'stuffy')
 
   await flushAll(t, users)
@@ -48,6 +50,8 @@ test('Basic get&set of Map property (converge via sync)', async function map1 (t
   for (let user of users) {
     var u = user.get('map', Y.Map)
     t.compare(u.get('stuff'), 'stuffy')
+    t.assert(u.get('undefined') === undefined, 'undefined')
+    t.compare(u.get('null'), null, 'null')
   }
   await compareUsers(t, users)
 })
@@ -172,31 +176,36 @@ test('observePath properties', async function map10 (t) {
 })
 */
 
-/* TODO: reimplement observeDeep
 test('observe deep properties', async function map11 (t) {
   let { users, map1, map2, map3 } = await initArrays(t, { users: 4 })
   var _map1 = map1.set('map', new Y.Map())
   var calls = 0
   var dmapid
-  _map1.observe(function (event) {
+  map1.observeDeep(function (events) {
-    calls++
+    events.forEach(event => {
-    t.compare(event.name, 'deepmap')
+      calls++
-    dmapid = event.target.opContents.deepmap
+      t.assert(event.keysChanged.has('deepmap'))
+      t.assert(event.path.length === 1)
+      t.assert(event.path[0] === 'map')
+      dmapid = event.target.get('deepmap')._id
+    })
   })
   await flushAll(t, users)
+  await flushAll(t, users)
   var _map3 = map3.get('map')
   _map3.set('deepmap', new Y.Map())
   await flushAll(t, users)
   var _map2 = map2.get('map')
   _map2.set('deepmap', new Y.Map())
   await flushAll(t, users)
+  await flushAll(t, users)
   var dmap1 = _map1.get('deepmap')
   var dmap2 = _map2.get('deepmap')
   var dmap3 = _map3.get('deepmap')
   t.assert(calls > 0)
-  t.compare(dmap1._model, dmap2._model)
+  t.assert(dmap1._id.equals(dmap2._id))
-  t.compare(dmap1._model, dmap3._model)
+  t.assert(dmap1._id.equals(dmap3._id))
-  t.compare(dmap1._model, dmapid)
+  t.assert(dmap1._id.equals(dmapid))
   await compareUsers(t, users)
 })
 
@@ -204,8 +213,10 @@ test('observes using observeDeep', async function map12 (t) {
   let { users, map0 } = await initArrays(t, { users: 2 })
   var pathes = []
   var calls = 0
-  map0.observeDeep(function (event) {
+  map0.observeDeep(function (events) {
-    pathes.push(event.path)
+    events.forEach(event => {
+      pathes.push(event.path)
+    })
     calls++
   })
   map0.set('map', new Y.Map())
@@ -215,7 +226,6 @@ test('observes using observeDeep', async function map12 (t) {
   t.compare(pathes, [[], ['map'], ['map', 'array']])
   await compareUsers(t, users)
 })
-*/
 
 /* TODO: Test events in Y.Map
 function compareEvent (t, is, should) {

tests-lib/helper.js

@@ -187,7 +187,7 @@ export async function flushAll (t, users) {
   if (users.length === 0) {
     return
   }
-  await wait(0)
+  await wait(10)
   if (users[0].connector.testRoom != null) {
     // use flushAll method specified in Test Connector
     await users[0].connector.testRoom.flushAll(users)