13.0.0-106

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: dmonad
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

README.md

@@ -17,10 +17,15 @@ suited for even large documents.
 * Discuss: [https://discuss.yjs.dev](https://discuss.yjs.dev)
 * Benchmarks:
   [https://github.com/dmonad/crdt-benchmarks](https://github.com/dmonad/crdt-benchmarks)
+* Podcast [**"Yjs Deep Dive into real time collaborative editing solutions":**](https://www.tag1consulting.com/blog/deep-dive-real-time-collaborative-editing-solutions-tagteamtalk-001-0)
+* Podcast [**"Google Docs-style editing in Gutenberg with the YJS framework":**](https://publishpress.com/blog/yjs/)
 
 :warning: This is the documentation for v13 (still in alpha). For the stable v12
 release checkout the [v12 docs](./README.v12.md) :warning:
 
+:construction_worker_woman: If you are looking for professional support to build
+collaborative or distributed applications ping us at <yjs@tag1consulting.com>.
+
 ## Table of Contents
 
 * [Overview](#Overview)
@@ -70,18 +75,19 @@ manage all that for you and are the perfect starting point for your
 collaborative app.
 
 <dl>
+  <dt><a href="http://github.com/yjs/y-webrtc">y-webrtc</a></dt>
+  <dd>
+Propagates document updates peer-to-peer using WebRTC. The peers exchange
+signaling data over signaling servers. Publically available signaling servers
+are available. Communication over the signaling servers can be encrypted by
+providing a shared secret, keeping the connection information and the shared
+document private.
+  </dd>
   <dt><a href="http://github.com/yjs/y-websocket">y-websocket</a></dt>
   <dd>
 A module that contains a simple websocket backend and a websocket client that
 connects to that backend. The backend can be extended to persist updates in a
 leveldb database.
-  </dd>
-  <dt><a href="http://github.com/yjs/y-mesh">y-mesh</a></dt>
-  <dd>
-[WIP] Creates a connected graph of webrtc connections with a high
-<a href="https://en.wikipedia.org/wiki/Strength_of_a_graph">strength</a>. It
-requires a signalling server that connects a client to the first peer. But after
-that the network manages itself. It is well suited for large and small networks.
   </dd>
   <dt><a href="http://github.com/yjs/y-dat">y-dat</a></dt>
   <dd>
@@ -97,7 +103,7 @@ hypercores and y-dat listens to changes and applies them to the Yjs document.
 Install Yjs and a provider with your favorite package manager:
 
 ```sh
-npm i yjs@13.0.0-97 y-websocket@1.0.0-6
+npm i yjs@13.0.0-103 y-websocket@1.0.0-6
 ```
 
 Start the y-websocket server:

package.json

@@ -1,23 +1,23 @@
 {
   "name": "yjs",
-  "version": "13.0.0-102",
+  "version": "13.0.0-106",
   "description": "Shared Editing Library",
-  "main": "./dist/yjs.js",
-  "module": "./dist/yjs.mjs",
+  "main": "./dist/yjs.cjs",
+  "module": "./src/index.js",
   "sideEffects": false,
   "scripts": {
-    "test": "npm run dist && PRODUCTION=1 node ./dist/tests.js --repitition-time 50 --production",
-    "test-exhaustive": "npm run lint && npm run dist && node ./dist/tests.js --repitition-time 10000",
+    "test": "npm run dist && node ./dist/tests.cjs --repitition-time 50",
+    "test-exhaustive": "npm run lint && npm run dist && node ./dist/tests.cjs --production --repitition-time 10000",
     "dist": "rm -rf dist && rollup -c",
     "watch": "rollup -wc",
     "lint": "markdownlint README.md && standard && tsc",
     "docs": "rm -rf docs; jsdoc --configure ./.jsdoc.json --verbose --readme ./README.md --package ./package.json || true",
-    "serve-docs": "npm run docs && serve ./docs/",
-    "preversion": "npm run lint && PRODUCTION=1 npm run dist && npm run docs && node ./dist/tests.js --repitition-time 1000",
+    "serve-docs": "npm run docs && http-server ./docs/",
+    "preversion": "npm run lint && PRODUCTION=1 npm run dist && npm run docs && node ./dist/tests.cjs --repitition-time 1000",
     "postversion": "git push && git push --tags",
-    "debug": "concurrently 'live-server --port=3443 --entry-file=test.html' 'npm run watch'",
-    "trace-deopt": "clear && rollup -c  && node --trace-deopt dist/test.js",
-    "trace-opt": "clear && rollup -c  && node --trace-opt dist/test.js"
+    "debug": "concurrently 'http-server -o test.html' 'npm run watch'",
+    "trace-deopt": "clear && rollup -c  && node --trace-deopt dist/test.cjs",
+    "trace-opt": "clear && rollup -c  && node --trace-opt dist/test.cjs"
   },
   "files": [
     "dist/*",
@@ -51,18 +51,20 @@
   },
   "homepage": "https://yjs.dev",
   "dependencies": {
-    "lib0": "^0.1.1"
+    "lib0": "^0.2.2"
   },
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^11.0.1",
+    "@rollup/plugin-node-resolve": "^7.0.0",
     "concurrently": "^3.6.1",
+    "http-server": "^0.12.1",
     "jsdoc": "^3.6.3",
-    "live-server": "^1.2.1",
-    "rollup": "^1.20.3",
+    "markdownlint-cli": "^0.19.0",
+    "rollup": "^1.29.0",
     "rollup-cli": "^1.0.9",
-    "rollup-plugin-node-resolve": "^4.2.4",
     "standard": "^11.0.1",
     "tui-jsdoc-template": "^1.2.2",
     "typescript": "^3.6.2",
-    "y-protocols": "0.0.6"
+    "y-protocols": "^0.2.0"
   }
 }

rollup.config.js

@@ -1,4 +1,5 @@
-import nodeResolve from 'rollup-plugin-node-resolve'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
 
 const localImports = process.env.LOCALIMPORTS
 
@@ -37,23 +38,18 @@ const debugResolve = {
 
 export default [{
   input: './src/index.js',
-  output: [{
+  output: {
     name: 'Y',
-    file: 'dist/yjs.js',
+    file: 'dist/yjs.cjs',
     format: 'cjs',
     sourcemap: true,
     paths: path => {
       if (/^lib0\//.test(path)) {
-        return `lib0/dist/${path.slice(5)}`
+        return `lib0/dist/${path.slice(5, -3)}.cjs`
       }
       return path
     }
-  }, {
-    name: 'Y',
-    file: 'dist/yjs.mjs',
-    format: 'es',
-    sourcemap: true
-  }],
+  },
   external: id => /^lib0\//.test(id)
 }, {
   input: './tests/index.js',
@@ -68,6 +64,24 @@ export default [{
     nodeResolve({
       sourcemap: true,
       mainFields: ['module', 'browser', 'main']
-    })
+    }),
+    commonjs()
   ]
+}, {
+  input: './tests/index.js',
+  output: {
+    name: 'test',
+    file: 'dist/tests.cjs',
+    format: 'cjs',
+    sourcemap: true
+  },
+  plugins: [
+    debugResolve,
+    nodeResolve({
+      sourcemap: true,
+      mainFields: ['module', 'main']
+    }),
+    commonjs()
+  ],
+  external: ['isomorphic.js']
 }]

src/index.js

@@ -53,6 +53,7 @@ export {
   decodeSnapshot,
   encodeSnapshot,
   isDeleted,
+  isParentOf,
   equalSnapshots,
   PermanentUserData // @TODO experimental
 } from './internals.js'

src/structs/Item.js

@@ -55,7 +55,7 @@ export const followRedone = (store, id) => {
     item = getItem(store, nextID)
     diff = nextID.clock - item.id.clock
     nextID = item.redone
-  } while (nextID !== null)
+  } while (nextID !== null && item instanceof Item)
   return {
     item, diff
   }

src/utils/Doc.js

@@ -23,11 +23,12 @@ import * as map from 'lib0/map.js'
  */
 export class Doc extends Observable {
   /**
-   * @param {Object|undefined} conf configuration
+   * @param {Object} conf configuration
+   * @param {boolean} [conf.gc] Disable garbage collection (default: gc=true)
    */
-  constructor (conf = {}) {
+  constructor ({ gc = true } = {}) {
     super()
-    this.gc = conf.gc || true
+    this.gc = gc
     this.clientID = random.uint32()
     /**
      * @type {Map<string, AbstractType<YEvent>>}

src/utils/PermanentUserData.js

@@ -83,33 +83,37 @@ export class PermanentUserData {
     }
     user.get('ids').push([clientid])
     users.observe(event => {
-      const userOverwrite = users.get(userDescription)
-      if (userOverwrite !== user) {
-        // user was overwritten, port all data over to the next user object
-        // @todo Experiment with Y.Sets here
-        user = userOverwrite
-        // @todo iterate over old type
-        this.clients.forEach((_userDescription, clientid) => {
-          if (userDescription === _userDescription) {
-            user.get('ids').push([clientid])
+      setTimeout(() => {
+        const userOverwrite = users.get(userDescription)
+        if (userOverwrite !== user) {
+          // user was overwritten, port all data over to the next user object
+          // @todo Experiment with Y.Sets here
+          user = userOverwrite
+          // @todo iterate over old type
+          this.clients.forEach((_userDescription, clientid) => {
+            if (userDescription === _userDescription) {
+              user.get('ids').push([clientid])
+            }
+          })
+          const encoder = encoding.createEncoder()
+          const ds = this.dss.get(userDescription)
+          if (ds) {
+            writeDeleteSet(encoder, ds)
+            user.get('ds').push([encoding.toUint8Array(encoder)])
           }
-        })
-        const encoder = encoding.createEncoder()
-        const ds = this.dss.get(userDescription)
-        if (ds) {
-          writeDeleteSet(encoder, ds)
-          user.get('ds').push([encoding.toUint8Array(encoder)])
         }
-      }
+      }, 0)
     })
     doc.on('afterTransaction', /** @param {Transaction} transaction */ transaction => {
-      const yds = user.get('ds')
-      const ds = transaction.deleteSet
-      if (transaction.local && ds.clients.size > 0) {
-        const encoder = encoding.createEncoder()
-        writeDeleteSet(encoder, ds)
-        yds.push([encoding.toUint8Array(encoder)])
-      }
+      setTimeout(() => {
+        const yds = user.get('ds')
+        const ds = transaction.deleteSet
+        if (transaction.local && ds.clients.size > 0) {
+          const encoder = encoding.createEncoder()
+          writeDeleteSet(encoder, ds)
+          yds.push([encoding.toUint8Array(encoder)])
+        }
+      })
     })
   }
   /**

src/utils/Transaction.js

@@ -73,7 +73,7 @@ export class Transaction {
     /**
      * All types that were directly modified (property added or child
      * inserted/deleted). New types are not included in this Set.
-     * Maps from type to parentSubs (`item._parentSub = null` for YArray)
+     * Maps from type to parentSubs (`item.parentSub = null` for YArray)
      * @type {Map<AbstractType<YEvent>,Set<String|null>>}
      */
     this.changed = new Map()