13.0.3

basic Y.Text toJSON returns {unformatted:string}

.bowerrc

@@ -1,3 +0,0 @@
-{
- "directory": "../"
-}

.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']

.gitignore

@@ -1,6 +1,4 @@
-/node_modules/
-bower_components
-.directory
-.c9
-.codio
-.settings
+node_modules
+dist
+.vscode
+docs

.jsdoc.json

@@ -0,0 +1,50 @@
+{
+  "sourceType": "module",
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc"]
+  },
+  "source": {
+    "include": ["./src"],
+    "includePattern": ".js$"
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "templates": {
+    "referenceTitle": "Yjs",
+    "disableSort": false,
+    "useCollapsibles": true,
+    "collapse": true,
+    "resources": {
+      "yjs.dev": "Yjs website"
+    },
+    "logo": {
+      "url": "https://user-images.githubusercontent.com/5553757/48975307-61efb100-f06d-11e8-9177-ee895e5916e5.png",
+      "width": "162px",
+      "height": "162px",
+      "link": "/"
+    },
+    "tabNames": {
+      "api": "API",
+      "tutorials": "Examples"
+    },
+    "footerText": "Shared Editing",
+    "css": [
+      "./style.css"
+    ],
+    "default": {
+      "staticFiles": {
+          "include": ["examples/"]
+      }
+    }
+  },
+  "opts": {
+    "destination": "./docs/",
+    "encoding": "utf8",
+    "private": false,
+    "recurse": true,
+    "template": "./node_modules/tui-jsdoc-template",
+    "tutorials": "./examples"
+  }
+}

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "default": true,
+  "no-inline-html": false
+}

LICENSE

@@ -1,6 +1,8 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Kevin Jahns <kevin.jahns@rwth-aachen.de>.
+Copyright (c) 2014
+  - Kevin Jahns <kevin.jahns@rwth-aachen.de>.
+  - Chair of Computer Science 5 (Databases & Information Systems), RWTH Aachen University, Germany
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,76 +1,865 @@
 
-# ![Yatta!](https://dadamonad.github.io/files/layout/yjs.svg)
+# ![Yjs](https://yjs.dev/images/logo/yjs-120x120.png)
 
-[![Build Status](http://layers.dbis.rwth-aachen.de/jenkins/job/Yatta/badge/icon)](http://layers.dbis.rwth-aachen.de/jenkins/job/Yatta/)
+> A CRDT framework with a powerful abstraction of shared data
 
-Yjs is a framework for optimistic concurrency control and automatic conflict resolution on arbitrary data types. The framework implements a new OT-like concurrency algorithm and provides similar functionality as [ShareJs] and [OpenCoweb]. Yjs was designed to take away the pain from concurrently editing complex data types like Text, Json, and XML. You can find some applications for this framework [here](https://dadamonad.github.io/yjs/examples/).
+Yjs is a [CRDT implementation](#Yjs-CRDT-Algorithm) that exposes its internal
+data structure as *shared types*. Shared types are common data types like `Map`
+or `Array` with superpowers: changes are automatically distributed to other
+peers and merged without merge conflicts.
 
-In the future, we want to enable users to implement their own collaborative types. Currently we provide data types for
-* Text
-* Json
-* XML
+Yjs is **network agnostic** (p2p!), supports many existing **rich text
+editors**, **offline editing**, **version snapshots**, **undo/redo** and
+**shared cursors**. It scales well with an unlimited number of users and is well
+suited for even large documents.
 
-Unlike other frameworks, Yjs supports P2P message propagation and is not bound to a specific communication protocol. Therefore, Yjs is extremely scalable and can be used in a wide range of application scenarios.
+* Demos: [https://github.com/yjs/yjs-demos](https://github.com/yjs/yjs-demos)
+* 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/)
 
-We support several communication protocols as so called *Connectors*. You find a bunch of Connectors in the [y-connectors](https://github.com/rwth-acis/y-connectors) repository. Currently supported communication protocols:
-* [XMPP-Connector](http://xmpp.org) - Propagates updates in a XMPP multi-user-chat room
-* [WebRTC-Connector](http://peerjs.com/) - Propagate updates directly with WebRTC
-* [IWC-Connector](http://dbis.rwth-aachen.de/cms/projects/the-xmpp-experience#interwidget-communication) - Inter-widget Communication
+:construction_worker_woman: If you are looking for professional support to build
+collaborative or distributed applications ping us at <yjs@tag1consulting.com>.
 
-You can use Yjs client-, and server- side. You can get it as via npm, and bower. We even provide a polymer element for Yjs!
+## Table of Contents
 
-The theoretical advantages over similar frameworks are support for
-* .. P2P message propagation and arbitrary communication protocols
-* .. arbitrary complex data types
-* .. offline editing: Only relevant changes are propagated on rejoin (unimplemented)
-* .. AnyUndo: Undo *any* action that was executed in constant time (unimplemented)
-* .. Intention Preservation: When working on Text, the intention of your changes are preserved. This is particularily important when working offline.
+* [Overview](#Overview)
+  * [Bindings](#Bindings)
+  * [Providers](#Providers)
+* [Getting Started](#Getting-Started)
+* [API](#API)
+  * [Shared Types](#Shared-Types)
+  * [Y.Doc](#YDoc)
+  * [Document Updates](#Document-Updates)
+  * [Relative Positions](#Relative-Positions)
+  * [Y.UndoManager](#YUndoManager)
+* [Miscellaneous](#Miscellaneous)
+  * [Typescript Declarations](#Typescript-Declarations)
+* [Yjs CRDT Algorithm](#Yjs-CRDT-Algorithm)
+* [Evaluation](#Evaluation)
+  * [Existing shared editing libraries](#Exisisting-Javascript-Libraries)
+  * [CRDT Algorithms](#CRDT-Algorithms)
+  * [Comparison of CRDT with OT](#Comparing-CRDT-with-OT)
+  * [Comparison of CRDT Algorithms](#Comparing-CRDT-Algorithms)
+  * [Comparison of Yjs with other Implementations](#Comparing-Yjs-with-other-Implementations)
+* [License and Author](#License-and-Author)
 
+## Overview
 
-## Use it!
-You find a tutorial, examples, and documentation on the [website](https://dadamonad.github.io/yjs/).
+This repository contains a collection of shared types that can be observed for
+changes and manipulated concurrently. Network functionality and two-way-bindings
+are implemented in separate modules.
 
-Either clone this git repository, install it with [bower](http://bower.io/), or install it with [npm](https://www.npmjs.org/package/yjs).
+### Bindings
 
-### Bower
-```
-bower install rwth-acis/yjs
-```
-Then you include the libraries directly from the installation folder.
-```
-<script src="./bower_components/yjs/y.js"></script>
+| Name | Cursors | Binding |  Demo |
+|---|:-:|---|---|
+| [ProseMirror](https://prosemirror.net/) &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | ✔ | [y-prosemirror](http://github.com/yjs/y-prosemirror) | [demo](https://yjs-demos.now.sh/prosemirror/) |
+| [Quill](https://quilljs.com/) | ✔ | [y-quill](http://github.com/yjs/y-quill) | [demo](https://yjs-demos.now.sh/quill/) |
+| [CodeMirror](https://codemirror.net/) | ✔ | [y-codemirror](http://github.com/yjs/y-codemirror) | [demo](https://yjs-demos.now.sh/codemirror/) |
+| [Monaco](https://microsoft.github.io/monaco-editor/) | ✔ | [y-monaco](http://github.com/yjs/y-monaco) | [demo](https://yjs-demos.now.sh/monaco/) |
+| [Ace](https://ace.c9.io/) | | [y-ace](http://github.com/yjs/y-ace) | [demo](https://yjs-demos.now.sh/ace/) |
+| [Textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) | | [y-textarea](http://github.com/yjs/y-textarea) | [demo](https://yjs-demos.now.sh/textarea/) |
+| [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model) | | [y-dom](http://github.com/yjs/y-dom) | [demo](https://yjs-demos.now.sh/dom/) |
+
+### Providers
+
+Setting up the communication between clients, managing awareness information,
+and storing shared data for offline usage is quite a hassle. **Providers**
+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-indexeddb">y-indexeddb</a></dt>
+  <dd>
+Efficiently persists document updates to the browsers indexeddb database.
+The document is immediately available and only diffs need to be synced through the
+network provider.
+  </dd>
+  <dt><a href="http://github.com/yjs/y-dat">y-dat</a></dt>
+  <dd>
+[WIP] Write document updates effinciently to the dat network using
+<a href="https://github.com/kappa-db/multifeed">multifeed</a>. Each client has
+an append-only log of CRDT local updates (hypercore). Multifeed manages and sync
+hypercores and y-dat listens to changes and applies them to the Yjs document.
+</dd>
+</dl>
+
+## Getting Started
+
+Install Yjs and a provider with your favorite package manager:
+
+```sh
+npm i yjs y-websocket
 ```
 
-### Npm
-```
-npm install yjs --save
+Start the y-websocket server:
+
+```sh
+PORT=1234 node ./node_modules/y-websocket/bin/server.js
 ```
 
-And use it like this with *npm*:
-```
-Y = require("yjs");
+### Example: Observe types
+
+```js
+const yarray = doc.getArray('my-array')
+yarray.observe(event => {
+  console.log('yarray was modified')
+})
+// every time a local or remote client modifies yarray, the observer is called
+yarray.insert(0, ['val']) // => "yarray was modified"
 ```
 
-## Status
-Yjs is still in an early development phase. Don't expect that everything is working fine.
-But I would become really motivated if you gave me some feedback :) ([github](https://github.com/rwth-acis/yjs/issues)).
+### Example: Nest types
 
-### Current Issues
-* The History Buffer should be able to store operations in a database
-* Documentation
-* Reimplement support for XML as a data type
-* Custom data types
+Remember, shared types are just plain old data types. The only limitation is
+that a shared type must exist only once in the shared document.
 
-## Support
-Please report _any_ issues to the [Github issue page](https://github.com/rwth-acis/yjs/issues)!
-I would appreciate if developers give me feedback on how _convenient_ the framework is, and if it is easy to use. Particularly the XML-support may not support every DOM-methods - if you encounter a method that does not cause any change on other peers, please state function name, and sample parameters. However, there are browser-specific features, that Y won't support.
+```js
+const ymap = doc.getMap('map')
+const foodArray = new Y.Array()
+foodArray.insert(0, ['apple', 'banana'])
+ymap.set('food', foodArray)
+ymap.get('food') === foodArray // => true
+ymap.set('fruit', foodArray) // => Error! foodArray is already defined
+```
 
-## License
-Yjs is licensed under the [MIT License](./LICENSE.txt).
+Now you understand how types are defined on a shared document. Next you can jump
+to the [demo repository](https://github.com/yjs/yjs-demos) or continue reading
+the API docs.
 
-<kevin.jahns@rwth-aachen.de>
+## API
 
-[ShareJs]: https://github.com/share/ShareJS
-[OpenCoweb]: https://github.com/opencoweb/coweb
+```js
+import * as Y from 'yjs'
+```
 
+### Shared Types
 
+<details>
+  <summary><b>Y.Array</b></summary>
+  <br>
+  <p>
+A shareable Array-like type that supports efficient insert/delete of elements
+at any position. Internally it uses a linked list of Arrays that is split when
+necessary.
+  </p>
+  <pre>const yarray = new Y.Array()</pre>
+  <dl>
+    <b><code>insert(index:number, content:Array&lt;object|boolean|Array|string|number|Uint8Array|Y.Type&gt;)</code></b>
+    <dd>
+Insert content at <var>index</var>. Note that content is an array of elements.
+I.e. <code>array.insert(0, [1]</code> splices the list and inserts 1 at
+position 0.
+    </dd>
+    <b><code>push(Array&lt;Object|boolean|Array|string|number|Uint8Array|Y.Type&gt;)</code></b>
+    <dd></dd>
+    <b><code>delete(index:number, length:number)</code></b>
+    <dd></dd>
+    <b><code>get(index:number)</code></b>
+    <dd></dd>
+    <b><code>length:number</code></b>
+    <dd></dd>
+    <b>
+      <code>
+forEach(function(value:object|boolean|Array|string|number|Uint8Array|Y.Type,
+ index:number, array: Y.Array))
+      </code>
+    </b>
+    <dd></dd>
+    <b><code>map(function(T, number, YArray):M):Array&lt;M&gt;</code></b>
+    <dd></dd>
+    <b><code>toArray():Array&lt;object|boolean|Array|string|number|Uint8Array|Y.Type&gt;</code></b>
+    <dd>Copies the content of this YArray to a new Array.</dd>
+    <b><code>toJSON():Array&lt;Object|boolean|Array|string|number&gt;</code></b>
+    <dd>
+Copies the content of this YArray to a new Array. It transforms all child types
+to JSON using their <code>toJSON</code> method.
+    </dd>
+    <b><code>[Symbol.Iterator]</code></b>
+    <dd>
+      Returns an YArray Iterator that contains the values for each index in the array.
+      <pre>for (let value of yarray) { .. }</pre>
+    </dd>
+    <b><code>observe(function(YArrayEvent, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type is modified. In the case this type is modified in the event listener,
+the event listener will be called again after the current event listener returns.
+    </dd>
+    <b><code>unobserve(function(YArrayEvent, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observe</code> event listener from this type.
+    </dd>
+    <b><code>observeDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type or any of its children is modified. In the case this type is modified
+in the event listener, the event listener will be called again after the current
+event listener returns. The event listener receives all Events created by itself
+or any of its children.
+    </dd>
+    <b><code>unobserveDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observeDeep</code> event listener from this type.
+    </dd>
+  </dl>
+</details>
+<details>
+  <summary><b>Y.Map</b></summary>
+  <br>
+  <p>
+    A shareable Map type.
+  </p>
+  <pre><code>const ymap = new Y.Map()</code></pre>
+  <dl>
+    <b><code>get(key:string):object|boolean|string|number|Uint8Array|Y.Type</code></b>
+    <dd></dd>
+    <b><code>set(key:string, value:object|boolean|string|number|Uint8Array|Y.Type)</code></b>
+    <dd></dd>
+    <b><code>delete(key:string)</code></b>
+    <dd></dd>
+    <b><code>has(key:string):boolean</code></b>
+    <dd></dd>
+    <b><code>get(index:number)</code></b>
+    <dd></dd>
+    <b><code>toJSON():Object&lt;string, Object|boolean|Array|string|number|Uint8Array&gt;</code></b>
+    <dd>
+Copies the <code>[key,value]</code> pairs of this YMap to a new Object.It
+transforms all child types to JSON using their <code>toJSON</code> method.
+    </dd>
+    <b><code>forEach(function(value:object|boolean|Array|string|number|Uint8Array|Y.Type,
+ key:string, map: Y.Map))</code></b>
+    <dd>
+      Execute the provided function once for every key-value pair.
+    </dd>
+    <b><code>[Symbol.Iterator]</code></b>
+    <dd>
+      Returns an Iterator of <code>[key, value]</code> pairs.
+      <pre>for (let [key, value] of ymap) { .. }</pre>
+    </dd>
+    <b><code>entries()</code></b>
+    <dd>
+      Returns an Iterator of <code>[key, value]</code> pairs.
+    </dd>
+    <b><code>values()</code></b>
+    <dd>
+      Returns an Iterator of all values.
+    </dd>
+    <b><code>keys()</code></b>
+    <dd>
+      Returns an Iterator of all keys.
+    </dd>
+    <b><code>observe(function(YMapEvent, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type is modified. In the case this type is modified in the event listener,
+the event listener will be called again after the current event listener returns.
+    </dd>
+    <b><code>unobserve(function(YMapEvent, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observe</code> event listener from this type.
+    </dd>
+    <b><code>observeDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type or any of its children is modified. In the case this type is modified
+in the event listener, the event listener will be called again after the current
+event listener returns. The event listener receives all Events created by itself
+or any of its children.
+    </dd>
+    <b><code>unobserveDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observeDeep</code> event listener from this type.
+    </dd>
+  </dl>
+</details>
+
+<details>
+  <summary><b>Y.Text</b></summary>
+  <br>
+  <p>
+A shareable type that is optimized for shared editing on text. It allows to
+assign properties to ranges in the text. This makes it possible to implement
+rich-text bindings to this type.
+  </p>
+  <p>
+This type can also be transformed to the
+<a href="https://quilljs.com/docs/delta">delta format</a>. Similarly the
+YTextEvents compute changes as deltas.
+  </p>
+  <pre>const ytext = new Y.Text()</pre>
+  <dl>
+    <b><code>insert(index:number, content:string, [formattingAttributes:Object&lt;string,string&gt;])</code></b>
+    <dd>
+      Insert a string at <var>index</var> and assign formatting attributes to it.
+      <pre>ytext.insert(0, 'bold text', { bold: true })</pre>
+    </dd>
+    <b><code>delete(index:number, length:number)</code></b>
+    <dd></dd>
+    <b><code>format(index:number, length:number, formattingAttributes:Object&lt;string,string&gt;)</code></b>
+    <dd>Assign formatting attributes to a range in the text</dd>
+    <b><code>applyDelta(delta)</code></b>
+    <dd>See <a href="https://quilljs.com/docs/delta/">Quill Delta</a></dd>
+    <b><code>length:number</code></b>
+    <dd></dd>
+    <b><code>toString():string</code></b>
+    <dd>Transforms this type, without formatting options, into a string.</dd>
+    <b><code>toJSON():string</code></b>
+    <dd>See <code>toString</code></dd>
+    <b><code>toDelta():Delta</code></b>
+    <dd>
+Transforms this type to a <a href="https://quilljs.com/docs/delta/">Quill Delta</a>
+    </dd>
+    <b><code>observe(function(YTextEvent, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type is modified. In the case this type is modified in the event listener,
+the event listener will be called again after the current event listener returns.
+    </dd>
+    <b><code>unobserve(function(YTextEvent, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observe</code> event listener from this type.
+    </dd>
+    <b><code>observeDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type or any of its children is modified. In the case this type is modified
+in the event listener, the event listener will be called again after the current
+event listener returns. The event listener receives all Events created by itself
+or any of its children.
+    </dd>
+    <b><code>unobserveDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observeDeep</code> event listener from this type.
+    </dd>
+  </dl>
+</details>
+
+<details>
+  <summary><b>Y.XmlFragment</b></summary>
+  <br>
+  <p>
+    A container that holds an Array of Y.XmlElements.
+  </p>
+  <pre><code>const yxml = new Y.XmlFragment()</code></pre>
+  <dl>
+    <b><code>insert(index:number, content:Array&lt;Y.XmlElement|Y.XmlText&gt;)</code></b>
+    <dd></dd>
+    <b><code>delete(index:number, length:number)</code></b>
+    <dd></dd>
+    <b><code>get(index:number)</code></b>
+    <dd></dd>
+    <b><code>length:number</code></b>
+    <dd></dd>
+    <b><code>toArray():Array&lt;Y.XmlElement|Y.XmlText&gt;</code></b>
+    <dd>Copies the children to a new Array.</dd>
+    <b><code>toDOM():DocumentFragment</code></b>
+    <dd>Transforms this type and all children to new DOM elements.</dd>
+    <b><code>toString():string</code></b>
+    <dd>Get the XML serialization of all descendants.</dd>
+    <b><code>toJSON():string</code></b>
+    <dd>See <code>toString</code>.</dd>
+    <b><code>observe(function(YXmlEvent, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type is modified. In the case this type is modified in the event listener,
+the event listener will be called again after the current event listener returns.
+    </dd>
+    <b><code>unobserve(function(YXmlEvent, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observe</code> event listener from this type.
+    </dd>
+    <b><code>observeDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type or any of its children is modified. In the case this type is modified
+in the event listener, the event listener will be called again after the current
+event listener returns. The event listener receives all Events created by itself
+or any of its children.
+    </dd>
+    <b><code>unobserveDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observeDeep</code> event listener from this type.
+    </dd>
+  </dl>
+</details>
+
+<details>
+  <summary><b>Y.XmlElement</b></summary>
+  <br>
+  <p>
+A shareable type that represents an XML Element. It has a <code>nodeName</code>,
+attributes, and a list of children. But it makes no effort to validate its
+content and be actually XML compliant.
+  </p>
+  <pre><code>const yxml = new Y.XmlElement()</code></pre>
+  <dl>
+    <b><code>insert(index:number, content:Array&lt;Y.XmlElement|Y.XmlText&gt;)</code></b>
+    <dd></dd>
+    <b><code>delete(index:number, length:number)</code></b>
+    <dd></dd>
+    <b><code>get(index:number)</code></b>
+    <dd></dd>
+    <b><code>length:number</code></b>
+    <dd></dd>
+    <b><code>setAttribute(attributeName:string, attributeValue:string)</code></b>
+    <dd></dd>
+    <b><code>removeAttribute(attributeName:string)</code></b>
+    <dd></dd>
+    <b><code>getAttribute(attributeName:string):string</code></b>
+    <dd></dd>
+    <b><code>getAttributes(attributeName:string):Object&lt;string,string&gt;</code></b>
+    <dd></dd>
+    <b><code>toArray():Array&lt;Y.XmlElement|Y.XmlText&gt;</code></b>
+    <dd>Copies the children to a new Array.</dd>
+    <b><code>toDOM():Element</code></b>
+    <dd>Transforms this type and all children to a new DOM element.</dd>
+    <b><code>toString():string</code></b>
+    <dd>Get the XML serialization of all descendants.</dd>
+    <b><code>toJSON():string</code></b>
+    <dd>See <code>toString</code>.</dd>
+    <b><code>observe(function(YXmlEvent, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every
+time this type is modified. In the case this type is modified in the event
+listener, the event listener will be called again after the current event
+listener returns.
+    </dd>
+    <b><code>unobserve(function(YXmlEvent, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observe</code> event listener from this type.
+    </dd>
+    <b><code>observeDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+Adds an event listener to this type that will be called synchronously every time
+this type or any of its children is modified. In the case this type is modified
+in the event listener, the event listener will be called again after the current
+event listener returns. The event listener receives all Events created by itself
+or any of its children.
+    </dd>
+    <b><code>unobserveDeep(function(Array&lt;YEvent&gt;, Transaction):void)</code></b>
+    <dd>
+      Removes an <code>observeDeep</code> event listener from this type.
+    </dd>
+  </dl>
+</details>
+
+### Y.Doc
+
+```js
+const doc = new Y.Doc()
+```
+
+<dl>
+  <b><code>clientID</code></b>
+  <dd>A unique id that identifies this client. (readonly)</dd>
+  <b><code>transact(function(Transaction):void [, origin:any])</code></b>
+  <dd>
+Every change on the shared document happens in a transaction. Observer calls and
+the <code>update</code> event are called after each transaction. You should
+<i>bundle</i> changes into a single transaction to reduce the amount of event
+calls. I.e. <code>doc.transact(() => { yarray.insert(..); ymap.set(..) })</code>
+triggers a single change event. <br>You can specify an optional <code>origin</code>
+parameter that is stored on <code>transaction.origin</code> and
+<code>on('update', (update, origin) => ..)</code>.
+  </dd>
+  <b><code>get(string, Y.[TypeClass]):[Type]</code></b>
+  <dd>Define a shared type.</dd>
+  <b><code>getArray(string):Y.Array</code></b>
+  <dd>Define a shared Y.Array type. Is equivalent to <code>y.get(string, Y.Array)</code>.</dd>
+  <b><code>getMap(string):Y.Map</code></b>
+  <dd>Define a shared Y.Map type. Is equivalent to <code>y.get(string, Y.Map)</code>.</dd>
+  <b><code>getXmlFragment(string):Y.XmlFragment</code></b>
+  <dd>Define a shared Y.XmlFragment type. Is equivalent to <code>y.get(string, Y.XmlFragment)</code>.</dd>
+  <b><code>on(string, function)</code></b>
+  <dd>Register an event listener on the shared type</dd>
+  <b><code>off(string, function)</code></b>
+  <dd>Unregister an event listener from the shared type</dd>
+</dl>
+
+#### Y.Doc Events
+
+<dl>
+  <b><code>on('update', function(updateMessage:Uint8Array, origin:any, Y.Doc):void)</code></b>
+  <dd>
+Listen to document updates. Document updates must be transmitted to all other
+peers. You can apply document updates in any order and multiple times.
+  </dd>
+  <b><code>on('beforeTransaction', function(Y.Transaction, Y.Doc):void)</code></b>
+  <dd>Emitted before each transaction.</dd>
+  <b><code>on('afterTransaction', function(Y.Transaction, Y.Doc):void)</code></b>
+  <dd>Emitted after each transaction.</dd>
+</dl>
+
+### Document Updates
+
+Changes on the shared document are encoded into *document updates*. Document
+updates are *commutative* and *idempotent*. This means that they can be applied
+in any order and multiple times.
+
+#### Example: Listen to update events and apply them on remote client
+
+```js
+const doc1 = new Y.Doc()
+const doc2 = new Y.Doc()
+
+doc1.on('update', update => {
+  Y.applyUpdate(doc2, update)
+})
+
+doc2.on('update', update => {
+  Y.applyUpdate(doc1, update)
+})
+
+// All changes are also applied to the other document
+doc1.getArray('myarray').insert(0, ['Hello doc2, you got this?'])
+doc2.getArray('myarray').get(0) // => 'Hello doc2, you got this?'
+```
+
+Yjs internally maintains a [state vector](#State-Vector) that denotes the next
+expected clock from each client. In a different interpretation it holds the
+number of structs created by each client. When two clients sync, you can either
+exchange the complete document structure or only the differences by sending the
+state vector to compute the differences.
+
+#### Example: Sync two clients by exchanging the complete document structure
+
+```js
+const state1 = Y.encodeStateAsUpdate(ydoc1)
+const state2 = Y.encodeStateAsUpdate(ydoc2)
+Y.applyUpdate(ydoc1, state2)
+Y.applyUpdate(ydoc2, state1)
+```
+
+#### Example: Sync two clients by computing the differences
+
+This example shows how to sync two clients with the minimal amount of exchanged
+data by computing only the differences using the state vector of the remote
+client. Syncing clients using the state vector requires another roundtrip, but
+can safe a lot of bandwidth.
+
+```js
+const stateVector1 = Y.encodeStateVector(ydoc1)
+const stateVector2 = Y.encodeStateVector(ydoc2)
+const diff1 = Y.encodeStateAsUpdate(ydoc1, stateVector2)
+const diff2 = Y.encodeStateAsUpdate(ydoc2, stateVector1)
+Y.applyUpdate(ydoc1, diff2)
+Y.applyUpdate(ydoc2, diff1)
+```
+
+<dl>
+  <b><code>Y.applyUpdate(Y.Doc, update:Uint8Array, [transactionOrigin:any])</code></b>
+  <dd>
+Apply a document update on the shared document. Optionally you can specify
+<code>transactionOrigin</code> that will be stored on
+<code>transaction.origin</code>
+and <code>ydoc.on('update', (update, origin) => ..)</code>.
+  </dd>
+  <b><code>Y.encodeStateAsUpdate(Y.Doc, [encodedTargetStateVector:Uint8Array]):Uint8Array</code></b>
+  <dd>
+Encode the document state as a single update message that can be applied on the
+remote document. Optionally specify the target state vector to only write the
+differences to the update message.
+  </dd>
+  <b><code>Y.encodeStateVector(Y.Doc):Uint8Array</code></b>
+  <dd>Computes the state vector and encodes it into an Uint8Array.</dd>
+</dl>
+
+### Relative Positions
+
+> This API is not stable yet
+
+This feature is intended for managing selections / cursors. When working with
+other users that manipulate the shared document, you can't trust that an index
+position (an integer) will stay at the intended location. A *relative position*
+is fixated to an element in the shared document and is not affected by remote
+changes. I.e. given the document `"a|c"`, the relative position is attached to
+`c`. When a remote user modifies the document by inserting a character before
+the cursor, the cursor will stay attached to the character `c`. `insert(1,
+'x')("a|c") = "ax|c"`. When the *relative position* is set to the end of the
+document, it will stay attached to the end of the document.
+
+#### Example: Transform to RelativePosition and back
+
+```js
+const relPos = Y.createRelativePositionFromTypeIndex(ytext, 2)
+const pos = Y.createAbsolutePositionFromRelativePosition(relPos, doc)
+pos.type === ytext // => true
+pos.index === 2 // => true
+```
+
+#### Example: Send relative position to remote client (json)
+
+```js
+const relPos = Y.createRelativePositionFromTypeIndex(ytext, 2)
+const encodedRelPos = JSON.stringify(relPos)
+// send encodedRelPos to remote client..
+const parsedRelPos = JSON.parse(encodedRelPos)
+const pos = Y.createAbsolutePositionFromRelativePosition(parsedRelPos, remoteDoc)
+pos.type === remoteytext // => true
+pos.index === 2 // => true
+```
+
+#### Example: Send relative position to remote client (Uint8Array)
+
+```js
+const relPos = Y.createRelativePositionFromTypeIndex(ytext, 2)
+const encodedRelPos = Y.encodeRelativePosition(relPos)
+// send encodedRelPos to remote client..
+const parsedRelPos = Y.decodeRelativePosition(encodedRelPos)
+const pos = Y.createAbsolutePositionFromRelativePosition(parsedRelPos, remoteDoc)
+pos.type === remoteytext // => true
+pos.index === 2 // => true
+```
+
+<dl>
+  <b><code>Y.createRelativePositionFromTypeIndex(Uint8Array|Y.Type, number)</code></b>
+  <dd></dd>
+  <b><code>Y.createAbsolutePositionFromRelativePosition(RelativePosition, Y.Doc)</code></b>
+  <dd></dd>
+  <b><code>Y.encodeRelativePosition(RelativePosition):Uint8Array</code></b>
+  <dd></dd>
+  <b><code>Y.decodeRelativePosition(Uint8Array):RelativePosition</code></b>
+  <dd></dd>
+</dl>
+
+### Y.UndoManager
+
+Yjs ships with an Undo/Redo manager for selective undo/redo of of changes on a
+Yjs type. The changes can be optionally scoped to transaction origins.
+
+```js
+const ytext = doc.getArray('array')
+const undoManager = new Y.UndoManager(ytext)
+
+ytext.insert(0, 'abc')
+undoManager.undo()
+ytext.toString() // => ''
+undoManager.redo()
+ytext.toString() // => 'abc'
+```
+
+<dl>
+  <b><code>constructor(scope:Y.AbstractType|Array&lt;Y.AbstractType&gt;,
+  [[{captureTimeout:number,trackedOrigins:Set&lt;any&gt;,deleteFilter:function(item):boolean}]])</code></b>
+  <dd>Accepts either single type as scope or an array of types.</dd>
+  <b><code>undo()</code></b>
+  <dd></dd>
+  <b><code>redo()</code></b>
+  <dd></dd>
+  <b><code>stopCapturing()</code></b>
+  <dd></dd>
+  <b>
+    <code>
+on('stack-item-added', { stackItem: { meta: Map&lt;any,any&gt; }, type: 'undo'
+| 'redo' })
+    </code>
+  </b>
+  <dd>
+Register an event that is called when a <code>StackItem</code> is added to the
+undo- or the redo-stack.
+  </dd>
+  <b>
+    <code>
+on('stack-item-popped', { stackItem: { meta: Map&lt;any,any&gt; }, type: 'undo'
+| 'redo' })
+    </code>
+  </b>
+  <dd>
+Register an event that is called when a <code>StackItem</code> is popped from
+the undo- or the redo-stack.
+  </dd>
+</dl>
+
+#### Example: Stop Capturing
+
+UndoManager merges Undo-StackItems if they are created within time-gap
+smaller than `options.captureTimeout`. Call `um.stopCapturing()` so that the next
+StackItem won't be merged.
+
+```js
+// without stopCapturing
+ytext.insert(0, 'a')
+ytext.insert(1, 'b')
+um.undo()
+ytext.toString() // => '' (note that 'ab' was removed)
+// with stopCapturing
+ytext.insert(0, 'a')
+um.stopCapturing()
+ytext.insert(0, 'b')
+um.undo()
+ytext.toString() // => 'a' (note that only 'b' was removed)
+```
+
+#### Example: Specify tracked origins
+
+Every change on the shared document has an origin. If no origin was specified,
+it defaults to `null`. By specifying `trackedTransactionOrigins` you can
+selectively specify which changes should be tracked by `UndoManager`. The
+UndoManager instance is always added to `trackedTransactionOrigins`.
+
+```js
+class CustomBinding {}
+
+const ytext = doc.getArray('array')
+const undoManager = new Y.UndoManager(ytext, new Set([42, CustomBinding]))
+
+ytext.insert(0, 'abc')
+undoManager.undo()
+ytext.toString() // => 'abc' (does not track because origin `null` and not part
+                 //           of `trackedTransactionOrigins`)
+ytext.delete(0, 3) // revert change
+
+doc.transact(() => {
+  ytext.insert(0, 'abc')
+}, 42)
+undoManager.undo()
+ytext.toString() // => '' (tracked because origin is an instance of `trackedTransactionorigins`)
+
+doc.transact(() => {
+  ytext.insert(0, 'abc')
+}, 41)
+undoManager.undo()
+ytext.toString() // => '' (not tracked because 41 is not an instance of
+                 //        `trackedTransactionorigins`)
+ytext.delete(0, 3) // revert change
+
+doc.transact(() => {
+  ytext.insert(0, 'abc')
+}, new CustomBinding())
+undoManager.undo()
+ytext.toString() // => '' (tracked because origin is a `CustomBinding` and
+                 //        `CustomBinding` is in `trackedTransactionorigins`)
+```
+
+#### Example: Add additional information to the StackItems
+
+When undoing or redoing a previous action, it is often expected to restore
+additional meta information like the cursor location or the view on the
+document. You can assign meta-information to Undo-/Redo-StackItems.
+
+```js
+const ytext = doc.getArray('array')
+const undoManager = new Y.UndoManager(ytext, new Set([42, CustomBinding]))
+
+undoManager.on('stack-item-added', event => {
+  // save the current cursor location on the stack-item
+  event.stackItem.meta.set('cursor-location', getRelativeCursorLocation())
+})
+
+undoManager.on('stack-item-popped', event => {
+  // restore the current cursor location on the stack-item
+  restoreCursorLocation(event.stackItem.meta.get('cursor-location'))
+})
+```
+
+## Miscellaneous
+
+### Typescript Declarations
+
+Yjs has type descriptions. But until [this
+ticket](https://github.com/Microsoft/TypeScript/issues/7546) is fixed, this is
+how you can make use of Yjs type declarations.
+
+```json
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+  },
+  "maxNodeModuleJsDepth": 5
+}
+```
+
+## Yjs CRDT Algorithm
+
+*Conflict-free replicated data types* (CRDT) for collaborative editing are an
+alternative approach to *operational transformation* (OT). A very simple
+differenciation between the two approaches is that OT attempts to transform
+index positions to ensure convergence (all clients end up with the same
+content), while CRDTs use mathematical models that usually do not involve index
+transformations, like linked lists. OT is currently the de-facto standard for
+shared editing on text. OT approaches that support shared editing without a
+central source of truth (a central server) require too much bookkeeping to be
+viable in practice. CRDTs are better suited for distributed systems, provide
+additional guarantees that the document can be synced with remote clients, and
+do not require a central source of truth.
+
+Yjs implements a modified version of the algorithm described in [this
+paper](https://www.researchgate.net/publication/310212186_Near_Real-Time_Peer-to-Peer_Shared_Editing_on_Extensible_Data_Types).
+I will eventually publish a paper that describes why this approach works so well
+in practice. Note: Since operations make up the document structure, we prefer
+the term *struct* now.
+
+CRDTs suitable for shared text editing suffer from the fact that they only grow
+in size. There are CRDTs that do not grow in size, but they do not have the
+characteristics that are benificial for shared text editing (like intention
+preservation). Yjs implements many improvements to the original algorithm that
+diminish the trade-off that the document only grows in size. We can't garbage
+collect deleted structs (tombstones) while ensuring a unique order of the
+structs. But we can 1. merge preceeding structs into a single struct to reduce
+the amount of meta information, 2. we can delete content from the struct if it
+is deleted, and 3. we can garbage collect tombstones if we don't care about the
+order of the structs anymore (e.g. if the parent was deleted).
+
+**Examples:**
+
+1. If a user inserts elements in sequence, the struct will be merged into a
+   single struct. E.g. `array.insert(0, ['a']), array.insert(0, ['b']);` is
+   first represented as two structs (`[{id: {client, clock: 0}, content: 'a'},
+   {id: {client, clock: 1}, content: 'b'}`) and then merged into a single
+   struct: `[{id: {client, clock: 0}, content: 'ab'}]`.
+2. When a struct that contains content (e.g. `ItemString`) is deleted, the
+   struct will be replaced with an `ItemDeleted` that does not contain content
+   anymore.
+3. When a type is deleted, all child elements are transformed to `GC` structs. A
+   `GC` struct only denotes the existence of a struct and that it is deleted.
+   `GC` structs can always be merged with other `GC` structs if the id's are
+   adjacent.
+
+Especially when working on structured content (e.g. shared editing on
+ProseMirror), these improvements yield very good results when
+[benchmarking](https://github.com/dmonad/crdt-benchmarks) random document edits.
+In practice they show even better results, because users usually edit text in
+sequence, resulting in structs that can easily be merged. The benchmarks show
+that even in the worst case scenario that a user edits text from right to left,
+Yjs achieves good performance even for huge documents.
+
+### State Vector
+
+Yjs has the ability to exchange only the differences when syncing two clients.
+We use lamport timestamps to identify structs and to track in which order a
+client created them. Each struct has an `struct.id = { client: number, clock:
+number}` that uniquely identifies a struct. We define the next expected `clock`
+by each client as the *state vector*. This data structure is similar to the
+[version vectors](https://en.wikipedia.org/wiki/Version_vector) data structure.
+But we use state vectors only to describe the state of the local document, so we
+can compute the missing struct of the remote client. We do not use it to track
+causality.
+
+## License and Author
+
+Yjs and all related projects are [**MIT licensed**](./LICENSE).
+
+Yjs is based on my research as a student at the [RWTH
+i5](http://dbis.rwth-aachen.de/). Now I am working on Yjs in my spare time.
+
+Fund this project by donating on [Patreon](https://www.patreon.com/dmonad) or
+hiring [me](https://github.com/dmonad) for professional support.

bower.json

@@ -1,33 +0,0 @@
-{
-  "name": "yjs",
-  "version": "0.3.2",
-  "homepage": "https://github.com/DadaMonad/yjs",
-  "authors": [
-    "Kevin Jahns <kevin.jahns@rwth-aachen.de>"
-  ],
-  "description": "A Framework that enables Real-Time collaboration on arbitrary data structures.",
-  "main": [
-    "./y.js",
-    "./y-object.html",
-    "./build/node/y.js"
-  ],
-  "keywords": [
-    "OT",
-    "collaboration",
-    "synchronization",
-    "ShareJS",
-    "Coweb",
-    "concurrency"
-  ],
-  "license": "MIT",
-  "ignore": [
-    "node_modules",
-    "bower_components",
-    "test",
-    "extras",
-    "test"
-  ],
-  "dependencies": {
-    "polymer": "Polymer/polymer#~0.5.3"
-  }
-}

build/README.md

@@ -1,11 +0,0 @@
-
-# Directories
-
-### build/browser
-You find the browserified (not minified) version of yjs here. This is nice for debugging, since it also includes sourcemaps. For production, however, you should use the version that you find in the main directory.
-
-### build/node
-Yjs for nodejs is located here. You can only use the submodules, or require 'y' in your node project. Also works with browserify.
-
-### build/test
-Start build/test/index.html' in your browser, to perform testing Yjs.

build/browser/y-object.html

@@ -1,7 +0,0 @@
-
-<polymer-element name="y-object" hidden attributes="val connector y">
-</polymer-element>
-<polymer-element name="y-property" hidden attributes="val name y">
-</polymer-element>
-
-<script src="./y-object.js"></script>

build/node/ConnectorAdapter.js

@@ -1,71 +0,0 @@
-var ConnectorClass, adaptConnector;
-
-ConnectorClass = require("./ConnectorClass");
-
-adaptConnector = function(connector, engine, HB, execution_listener) {
-  var applyHB, encode_state_vector, f, getHB, getStateVector, name, parse_state_vector, send_;
-  for (name in ConnectorClass) {
-    f = ConnectorClass[name];
-    connector[name] = f;
-  }
-  connector.setIsBoundToY();
-  send_ = function(o) {
-    if ((o.uid.creator === HB.getUserId()) && (typeof o.uid.op_number !== "string") && (o.uid.doSync === "true" || o.uid.doSync === true) && (HB.getUserId() !== "_temp")) {
-      return connector.broadcast(o);
-    }
-  };
-  if (connector.invokeSync != null) {
-    HB.setInvokeSyncHandler(connector.invokeSync);
-  }
-  execution_listener.push(send_);
-  encode_state_vector = function(v) {
-    var value, _results;
-    _results = [];
-    for (name in v) {
-      value = v[name];
-      _results.push({
-        user: name,
-        state: value
-      });
-    }
-    return _results;
-  };
-  parse_state_vector = function(v) {
-    var s, state_vector, _i, _len;
-    state_vector = {};
-    for (_i = 0, _len = v.length; _i < _len; _i++) {
-      s = v[_i];
-      state_vector[s.user] = s.state;
-    }
-    return state_vector;
-  };
-  getStateVector = function() {
-    return encode_state_vector(HB.getOperationCounter());
-  };
-  getHB = function(v) {
-    var hb, json, state_vector;
-    state_vector = parse_state_vector(v);
-    hb = HB._encode(state_vector);
-    json = {
-      hb: hb,
-      state_vector: encode_state_vector(HB.getOperationCounter())
-    };
-    return json;
-  };
-  applyHB = function(hb, fromHB) {
-    return engine.applyOp(hb, fromHB);
-  };
-  connector.getStateVector = getStateVector;
-  connector.getHB = getHB;
-  connector.applyHB = applyHB;
-  if (connector.receive_handlers == null) {
-    connector.receive_handlers = [];
-  }
-  return connector.receive_handlers.push(function(sender, op) {
-    if (op.uid.creator !== HB.getUserId()) {
-      return engine.applyOp(op);
-    }
-  });
-};
-
-module.exports = adaptConnector;

build/node/ConnectorClass.js

@@ -1,355 +0,0 @@
-module.exports = {
-  init: function(options) {
-    var req;
-    req = (function(_this) {
-      return function(name, choices) {
-        if (options[name] != null) {
-          if ((choices == null) || choices.some(function(c) {
-            return c === options[name];
-          })) {
-            return _this[name] = options[name];
-          } else {
-            throw new Error("You can set the '" + name + "' option to one of the following choices: " + JSON.encode(choices));
-          }
-        } else {
-          throw new Error("You must specify " + name + ", when initializing the Connector!");
-        }
-      };
-    })(this);
-    req("syncMethod", ["syncAll", "master-slave"]);
-    req("role", ["master", "slave"]);
-    req("user_id");
-    if (typeof this.on_user_id_set === "function") {
-      this.on_user_id_set(this.user_id);
-    }
-    if (options.perform_send_again != null) {
-      this.perform_send_again = options.perform_send_again;
-    } else {
-      this.perform_send_again = true;
-    }
-    if (this.role === "master") {
-      this.syncMethod = "syncAll";
-    }
-    this.is_synced = false;
-    this.connections = {};
-    if (this.receive_handlers == null) {
-      this.receive_handlers = [];
-    }
-    this.connections = {};
-    this.current_sync_target = null;
-    this.sent_hb_to_all_users = false;
-    return this.is_initialized = true;
-  },
-  isRoleMaster: function() {
-    return this.role === "master";
-  },
-  isRoleSlave: function() {
-    return this.role === "slave";
-  },
-  findNewSyncTarget: function() {
-    var c, user, _ref;
-    this.current_sync_target = null;
-    if (this.syncMethod === "syncAll") {
-      _ref = this.connections;
-      for (user in _ref) {
-        c = _ref[user];
-        if (!c.is_synced) {
-          this.performSync(user);
-          break;
-        }
-      }
-    }
-    if (this.current_sync_target == null) {
-      this.setStateSynced();
-    }
-    return null;
-  },
-  userLeft: function(user) {
-    delete this.connections[user];
-    return this.findNewSyncTarget();
-  },
-  userJoined: function(user, role) {
-    var _base;
-    if (role == null) {
-      throw new Error("Internal: You must specify the role of the joined user! E.g. userJoined('uid:3939','slave')");
-    }
-    if ((_base = this.connections)[user] == null) {
-      _base[user] = {};
-    }
-    this.connections[user].is_synced = false;
-    if ((!this.is_synced) || this.syncMethod === "syncAll") {
-      if (this.syncMethod === "syncAll") {
-        return this.performSync(user);
-      } else if (role === "master") {
-        return this.performSyncWithMaster(user);
-      }
-    }
-  },
-  whenSynced: function(args) {
-    if (args.constructore === Function) {
-      args = [args];
-    }
-    if (this.is_synced) {
-      return args[0].apply(this, args.slice(1));
-    } else {
-      if (this.compute_when_synced == null) {
-        this.compute_when_synced = [];
-      }
-      return this.compute_when_synced.push(args);
-    }
-  },
-  onReceive: function(f) {
-    return this.receive_handlers.push(f);
-  },
-
-  /*
-   * Broadcast a message to all connected peers.
-   * @param message {Object} The message to broadcast.
-   *
-  broadcast: (message)->
-    throw new Error "You must implement broadcast!"
-  
-   *
-   * Send a message to a peer, or set of peers
-   *
-  send: (peer_s, message)->
-    throw new Error "You must implement send!"
-   */
-  performSync: function(user) {
-    var hb, o, _hb, _i, _len;
-    if (this.current_sync_target == null) {
-      this.current_sync_target = user;
-      this.send(user, {
-        sync_step: "getHB",
-        send_again: "true",
-        data: []
-      });
-      if (!this.sent_hb_to_all_users) {
-        this.sent_hb_to_all_users = true;
-        hb = this.getHB([]).hb;
-        _hb = [];
-        for (_i = 0, _len = hb.length; _i < _len; _i++) {
-          o = hb[_i];
-          _hb.push(o);
-          if (_hb.length > 30) {
-            this.broadcast({
-              sync_step: "applyHB_",
-              data: _hb
-            });
-            _hb = [];
-          }
-        }
-        return this.broadcast({
-          sync_step: "applyHB",
-          data: _hb
-        });
-      }
-    }
-  },
-  performSyncWithMaster: function(user) {
-    var hb, o, _hb, _i, _len;
-    this.current_sync_target = user;
-    this.send(user, {
-      sync_step: "getHB",
-      send_again: "true",
-      data: []
-    });
-    hb = this.getHB([]).hb;
-    _hb = [];
-    for (_i = 0, _len = hb.length; _i < _len; _i++) {
-      o = hb[_i];
-      _hb.push(o);
-      if (_hb.length > 30) {
-        this.broadcast({
-          sync_step: "applyHB_",
-          data: _hb
-        });
-        _hb = [];
-      }
-    }
-    return this.broadcast({
-      sync_step: "applyHB",
-      data: _hb
-    });
-  },
-  setStateSynced: function() {
-    var f, _i, _len, _ref;
-    if (!this.is_synced) {
-      this.is_synced = true;
-      if (this.compute_when_synced != null) {
-        _ref = this.compute_when_synced;
-        for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-          f = _ref[_i];
-          f();
-        }
-        delete this.compute_when_synced;
-      }
-      return null;
-    }
-  },
-  receiveMessage: function(sender, res) {
-    var data, f, hb, o, sendApplyHB, send_again, _hb, _i, _j, _len, _len1, _ref, _results;
-    if (res.sync_step == null) {
-      _ref = this.receive_handlers;
-      _results = [];
-      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-        f = _ref[_i];
-        _results.push(f(sender, res));
-      }
-      return _results;
-    } else {
-      if (sender === this.user_id) {
-        return;
-      }
-      if (res.sync_step === "getHB") {
-        data = this.getHB(res.data);
-        hb = data.hb;
-        _hb = [];
-        if (this.is_synced) {
-          sendApplyHB = (function(_this) {
-            return function(m) {
-              return _this.send(sender, m);
-            };
-          })(this);
-        } else {
-          sendApplyHB = (function(_this) {
-            return function(m) {
-              return _this.broadcast(m);
-            };
-          })(this);
-        }
-        for (_j = 0, _len1 = hb.length; _j < _len1; _j++) {
-          o = hb[_j];
-          _hb.push(o);
-          if (_hb.length > 30) {
-            sendApplyHB({
-              sync_step: "applyHB_",
-              data: _hb
-            });
-            _hb = [];
-          }
-        }
-        sendApplyHB({
-          sync_step: "applyHB",
-          data: _hb
-        });
-        if ((res.send_again != null) && this.perform_send_again) {
-          send_again = (function(_this) {
-            return function(sv) {
-              return function() {
-                hb = _this.getHB(sv).hb;
-                return _this.send(sender, {
-                  sync_step: "applyHB",
-                  data: hb,
-                  sent_again: "true"
-                });
-              };
-            };
-          })(this)(data.state_vector);
-          return setTimeout(send_again, 3000);
-        }
-      } else if (res.sync_step === "applyHB") {
-        this.applyHB(res.data, sender === this.current_sync_target);
-        if ((this.syncMethod === "syncAll" || (res.sent_again != null)) && (!this.is_synced) && ((this.current_sync_target === sender) || (this.current_sync_target == null))) {
-          this.connections[sender].is_synced = true;
-          return this.findNewSyncTarget();
-        }
-      } else if (res.sync_step === "applyHB_") {
-        return this.applyHB(res.data, sender === this.current_sync_target);
-      }
-    }
-  },
-  parseMessageFromXml: function(m) {
-    var parse_array, parse_object;
-    parse_array = function(node) {
-      var n, _i, _len, _ref, _results;
-      _ref = node.children;
-      _results = [];
-      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-        n = _ref[_i];
-        if (n.getAttribute("isArray") === "true") {
-          _results.push(parse_array(n));
-        } else {
-          _results.push(parse_object(n));
-        }
-      }
-      return _results;
-    };
-    parse_object = function(node) {
-      var int, json, n, name, value, _i, _len, _ref, _ref1;
-      json = {};
-      _ref = node.attrs;
-      for (name in _ref) {
-        value = _ref[name];
-        int = parseInt(value);
-        if (isNaN(int) || ("" + int) !== value) {
-          json[name] = value;
-        } else {
-          json[name] = int;
-        }
-      }
-      _ref1 = node.children;
-      for (_i = 0, _len = _ref1.length; _i < _len; _i++) {
-        n = _ref1[_i];
-        name = n.name;
-        if (n.getAttribute("isArray") === "true") {
-          json[name] = parse_array(n);
-        } else {
-          json[name] = parse_object(n);
-        }
-      }
-      return json;
-    };
-    return parse_object(m);
-  },
-  encodeMessageToXml: function(m, json) {
-    var encode_array, encode_object;
-    encode_object = function(m, json) {
-      var name, value;
-      for (name in json) {
-        value = json[name];
-        if (value == null) {
-
-        } else if (value.constructor === Object) {
-          encode_object(m.c(name), value);
-        } else if (value.constructor === Array) {
-          encode_array(m.c(name), value);
-        } else {
-          m.setAttribute(name, value);
-        }
-      }
-      return m;
-    };
-    encode_array = function(m, array) {
-      var e, _i, _len;
-      m.setAttribute("isArray", "true");
-      for (_i = 0, _len = array.length; _i < _len; _i++) {
-        e = array[_i];
-        if (e.constructor === Object) {
-          encode_object(m.c("array-element"), e);
-        } else {
-          encode_array(m.c("array-element"), e);
-        }
-      }
-      return m;
-    };
-    if (json.constructor === Object) {
-      return encode_object(m.c("y", {
-        xmlns: "http://y.ninja/connector-stanza"
-      }), json);
-    } else if (json.constructor === Array) {
-      return encode_array(m.c("y", {
-        xmlns: "http://y.ninja/connector-stanza"
-      }), json);
-    } else {
-      throw new Error("I can't encode this json!");
-    }
-  },
-  setIsBoundToY: function() {
-    if (typeof this.on_bound_to_y === "function") {
-      this.on_bound_to_y();
-    }
-    delete this.when_bound_to_y;
-    return this.is_bound_to_y = true;
-  }
-};

build/node/Engine.js

@@ -1,119 +0,0 @@
-var Engine;
-
-if (typeof window !== "undefined" && window !== null) {
-  window.unprocessed_counter = 0;
-}
-
-if (typeof window !== "undefined" && window !== null) {
-  window.unprocessed_exec_counter = 0;
-}
-
-if (typeof window !== "undefined" && window !== null) {
-  window.unprocessed_types = [];
-}
-
-Engine = (function() {
-  function Engine(HB, types) {
-    this.HB = HB;
-    this.types = types;
-    this.unprocessed_ops = [];
-  }
-
-  Engine.prototype.parseOperation = function(json) {
-    var type;
-    type = this.types[json.type];
-    if ((type != null ? type.parse : void 0) != null) {
-      return type.parse(json);
-    } else {
-      throw new Error("You forgot to specify a parser for type " + json.type + ". The message is " + (JSON.stringify(json)) + ".");
-    }
-  };
-
-
-  /*
-  applyOpsBundle: (ops_json)->
-    ops = []
-    for o in ops_json
-      ops.push @parseOperation o
-    for o in ops
-      if not o.execute()
-        @unprocessed_ops.push o
-    @tryUnprocessed()
-   */
-
-  Engine.prototype.applyOpsCheckDouble = function(ops_json) {
-    var o, _i, _len, _results;
-    _results = [];
-    for (_i = 0, _len = ops_json.length; _i < _len; _i++) {
-      o = ops_json[_i];
-      if (this.HB.getOperation(o.uid) == null) {
-        _results.push(this.applyOp(o));
-      } else {
-        _results.push(void 0);
-      }
-    }
-    return _results;
-  };
-
-  Engine.prototype.applyOps = function(ops_json) {
-    return this.applyOp(ops_json);
-  };
-
-  Engine.prototype.applyOp = function(op_json_array, fromHB) {
-    var o, op_json, _i, _len;
-    if (fromHB == null) {
-      fromHB = false;
-    }
-    if (op_json_array.constructor !== Array) {
-      op_json_array = [op_json_array];
-    }
-    for (_i = 0, _len = op_json_array.length; _i < _len; _i++) {
-      op_json = op_json_array[_i];
-      if (fromHB) {
-        op_json.fromHB = "true";
-      }
-      o = this.parseOperation(op_json);
-      if (op_json.fromHB != null) {
-        o.fromHB = op_json.fromHB;
-      }
-      if (this.HB.getOperation(o) != null) {
-
-      } else if (((!this.HB.isExpectedOperation(o)) && (o.fromHB == null)) || (!o.execute())) {
-        this.unprocessed_ops.push(o);
-        if (typeof window !== "undefined" && window !== null) {
-          window.unprocessed_types.push(o.type);
-        }
-      }
-    }
-    return this.tryUnprocessed();
-  };
-
-  Engine.prototype.tryUnprocessed = function() {
-    var old_length, op, unprocessed, _i, _len, _ref;
-    while (true) {
-      old_length = this.unprocessed_ops.length;
-      unprocessed = [];
-      _ref = this.unprocessed_ops;
-      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-        op = _ref[_i];
-        if (this.HB.getOperation(op) != null) {
-
-        } else if ((!this.HB.isExpectedOperation(op) && (op.fromHB == null)) || (!op.execute())) {
-          unprocessed.push(op);
-        }
-      }
-      this.unprocessed_ops = unprocessed;
-      if (this.unprocessed_ops.length === old_length) {
-        break;
-      }
-    }
-    if (this.unprocessed_ops.length !== 0) {
-      return this.HB.invokeSync();
-    }
-  };
-
-  return Engine;
-
-})();
-
-module.exports = Engine;

build/node/HistoryBuffer.js

@@ -1,257 +0,0 @@
-var HistoryBuffer,
-  __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
-
-HistoryBuffer = (function() {
-  function HistoryBuffer(user_id) {
-    this.user_id = user_id;
-    this.emptyGarbage = __bind(this.emptyGarbage, this);
-    this.operation_counter = {};
-    this.buffer = {};
-    this.change_listeners = [];
-    this.garbage = [];
-    this.trash = [];
-    this.performGarbageCollection = true;
-    this.garbageCollectTimeout = 30000;
-    this.reserved_identifier_counter = 0;
-    setTimeout(this.emptyGarbage, this.garbageCollectTimeout);
-  }
-
-  HistoryBuffer.prototype.resetUserId = function(id) {
-    var o, o_name, own;
-    own = this.buffer[this.user_id];
-    if (own != null) {
-      for (o_name in own) {
-        o = own[o_name];
-        if (o.uid.creator != null) {
-          o.uid.creator = id;
-        }
-        if (o.uid.alt != null) {
-          o.uid.alt.creator = id;
-        }
-      }
-      if (this.buffer[id] != null) {
-        throw new Error("You are re-assigning an old user id - this is not (yet) possible!");
-      }
-      this.buffer[id] = own;
-      delete this.buffer[this.user_id];
-    }
-    if (this.operation_counter[this.user_id] != null) {
-      this.operation_counter[id] = this.operation_counter[this.user_id];
-      delete this.operation_counter[this.user_id];
-    }
-    return this.user_id = id;
-  };
-
-  HistoryBuffer.prototype.emptyGarbage = function() {
-    var o, _i, _len, _ref;
-    _ref = this.garbage;
-    for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-      o = _ref[_i];
-      if (typeof o.cleanup === "function") {
-        o.cleanup();
-      }
-    }
-    this.garbage = this.trash;
-    this.trash = [];
-    if (this.garbageCollectTimeout !== -1) {
-      this.garbageCollectTimeoutId = setTimeout(this.emptyGarbage, this.garbageCollectTimeout);
-    }
-    return void 0;
-  };
-
-  HistoryBuffer.prototype.getUserId = function() {
-    return this.user_id;
-  };
-
-  HistoryBuffer.prototype.addToGarbageCollector = function() {
-    var o, _i, _len, _results;
-    if (this.performGarbageCollection) {
-      _results = [];
-      for (_i = 0, _len = arguments.length; _i < _len; _i++) {
-        o = arguments[_i];
-        if (o != null) {
-          _results.push(this.garbage.push(o));
-        } else {
-          _results.push(void 0);
-        }
-      }
-      return _results;
-    }
-  };
-
-  HistoryBuffer.prototype.stopGarbageCollection = function() {
-    this.performGarbageCollection = false;
-    this.setManualGarbageCollect();
-    this.garbage = [];
-    return this.trash = [];
-  };
-
-  HistoryBuffer.prototype.setManualGarbageCollect = function() {
-    this.garbageCollectTimeout = -1;
-    clearTimeout(this.garbageCollectTimeoutId);
-    return this.garbageCollectTimeoutId = void 0;
-  };
-
-  HistoryBuffer.prototype.setGarbageCollectTimeout = function(garbageCollectTimeout) {
-    this.garbageCollectTimeout = garbageCollectTimeout;
-  };
-
-  HistoryBuffer.prototype.getReservedUniqueIdentifier = function() {
-    return {
-      creator: '_',
-      op_number: "_" + (this.reserved_identifier_counter++),
-      doSync: false
-    };
-  };
-
-  HistoryBuffer.prototype.getOperationCounter = function(user_id) {
-    var ctn, res, user, _ref;
-    if (user_id == null) {
-      res = {};
-      _ref = this.operation_counter;
-      for (user in _ref) {
-        ctn = _ref[user];
-        res[user] = ctn;
-      }
-      return res;
-    } else {
-      return this.operation_counter[user_id];
-    }
-  };
-
-  HistoryBuffer.prototype.isExpectedOperation = function(o) {
-    var _base, _name;
-    if ((_base = this.operation_counter)[_name = o.uid.creator] == null) {
-      _base[_name] = 0;
-    }
-    o.uid.op_number <= this.operation_counter[o.uid.creator];
-    return true;
-  };
-
-  HistoryBuffer.prototype._encode = function(state_vector) {
-    var json, o, o_json, o_next, o_number, o_prev, u_name, unknown, user, _ref;
-    if (state_vector == null) {
-      state_vector = {};
-    }
-    json = [];
-    unknown = function(user, o_number) {
-      if ((user == null) || (o_number == null)) {
-        throw new Error("dah!");
-      }
-      return (state_vector[user] == null) || state_vector[user] <= o_number;
-    };
-    _ref = this.buffer;
-    for (u_name in _ref) {
-      user = _ref[u_name];
-      for (o_number in user) {
-        o = user[o_number];
-        if ((o.uid.noOperation == null) && o.uid.doSync && unknown(u_name, o_number)) {
-          o_json = o._encode();
-          if (o.next_cl != null) {
-            o_next = o.next_cl;
-            while ((o_next.next_cl != null) && unknown(o_next.uid.creator, o_next.uid.op_number)) {
-              o_next = o_next.next_cl;
-            }
-            o_json.next = o_next.getUid();
-          } else if (o.prev_cl != null) {
-            o_prev = o.prev_cl;
-            while ((o_prev.prev_cl != null) && unknown(o_prev.uid.creator, o_prev.uid.op_number)) {
-              o_prev = o_prev.prev_cl;
-            }
-            o_json.prev = o_prev.getUid();
-          }
-          json.push(o_json);
-        }
-      }
-    }
-    return json;
-  };
-
-  HistoryBuffer.prototype.getNextOperationIdentifier = function(user_id) {
-    var uid;
-    if (user_id == null) {
-      user_id = this.user_id;
-    }
-    if (this.operation_counter[user_id] == null) {
-      this.operation_counter[user_id] = 0;
-    }
-    uid = {
-      'creator': user_id,
-      'op_number': this.operation_counter[user_id],
-      'doSync': true
-    };
-    this.operation_counter[user_id]++;
-    return uid;
-  };
-
-  HistoryBuffer.prototype.getOperation = function(uid) {
-    var o, _ref;
-    if (uid.uid != null) {
-      uid = uid.uid;
-    }
-    o = (_ref = this.buffer[uid.creator]) != null ? _ref[uid.op_number] : void 0;
-    if ((uid.sub != null) && (o != null)) {
-      return o.retrieveSub(uid.sub);
-    } else {
-      return o;
-    }
-  };
-
-  HistoryBuffer.prototype.addOperation = function(o) {
-    if (this.buffer[o.uid.creator] == null) {
-      this.buffer[o.uid.creator] = {};
-    }
-    if (this.buffer[o.uid.creator][o.uid.op_number] != null) {
-      throw new Error("You must not overwrite operations!");
-    }
-    if ((o.uid.op_number.constructor !== String) && (!this.isExpectedOperation(o)) && (o.fromHB == null)) {
-      throw new Error("this operation was not expected!");
-    }
-    this.addToCounter(o);
-    this.buffer[o.uid.creator][o.uid.op_number] = o;
-    return o;
-  };
-
-  HistoryBuffer.prototype.removeOperation = function(o) {
-    var _ref;
-    return (_ref = this.buffer[o.uid.creator]) != null ? delete _ref[o.uid.op_number] : void 0;
-  };
-
-  HistoryBuffer.prototype.setInvokeSyncHandler = function(f) {
-    return this.invokeSync = f;
-  };
-
-  HistoryBuffer.prototype.invokeSync = function() {};
-
-  HistoryBuffer.prototype.renewStateVector = function(state_vector) {
-    var state, user, _results;
-    _results = [];
-    for (user in state_vector) {
-      state = state_vector[user];
-      if (((this.operation_counter[user] == null) || (this.operation_counter[user] < state_vector[user])) && (state_vector[user] != null)) {
-        _results.push(this.operation_counter[user] = state_vector[user]);
-      } else {
-        _results.push(void 0);
-      }
-    }
-    return _results;
-  };
-
-  HistoryBuffer.prototype.addToCounter = function(o) {
-    if (this.operation_counter[o.uid.creator] == null) {
-      this.operation_counter[o.uid.creator] = 0;
-    }
-    if (typeof o.uid.op_number === 'number' && o.uid.creator !== this.getUserId()) {
-      if (o.uid.op_number === this.operation_counter[o.uid.creator]) {
-        return this.operation_counter[o.uid.creator]++;
-      } else {
-        return this.invokeSync(o.uid.creator);
-      }
-    }
-  };
-
-  return HistoryBuffer;
-
-})();
-
-module.exports = HistoryBuffer;

build/node/Types/BasicTypes.js

@@ -1,495 +0,0 @@
-var __slice = [].slice,
-  __hasProp = {}.hasOwnProperty,
-  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
-
-module.exports = function(HB) {
-  var execution_listener, types;
-  types = {};
-  execution_listener = [];
-  types.Operation = (function() {
-    function Operation(uid) {
-      this.is_deleted = false;
-      this.garbage_collected = false;
-      this.event_listeners = [];
-      if (uid != null) {
-        this.uid = uid;
-      }
-    }
-
-    Operation.prototype.type = "Operation";
-
-    Operation.prototype.retrieveSub = function() {
-      throw new Error("sub properties are not enable on this operation type!");
-    };
-
-    Operation.prototype.observe = function(f) {
-      return this.event_listeners.push(f);
-    };
-
-    Operation.prototype.unobserve = function(f) {
-      return this.event_listeners = this.event_listeners.filter(function(g) {
-        return f !== g;
-      });
-    };
-
-    Operation.prototype.deleteAllObservers = function() {
-      return this.event_listeners = [];
-    };
-
-    Operation.prototype["delete"] = function() {
-      (new types.Delete(void 0, this)).execute();
-      return null;
-    };
-
-    Operation.prototype.callEvent = function() {
-      return this.forwardEvent.apply(this, [this].concat(__slice.call(arguments)));
-    };
-
-    Operation.prototype.forwardEvent = function() {
-      var args, f, op, _i, _len, _ref, _results;
-      op = arguments[0], args = 2 <= arguments.length ? __slice.call(arguments, 1) : [];
-      _ref = this.event_listeners;
-      _results = [];
-      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-        f = _ref[_i];
-        _results.push(f.call.apply(f, [op].concat(__slice.call(args))));
-      }
-      return _results;
-    };
-
-    Operation.prototype.isDeleted = function() {
-      return this.is_deleted;
-    };
-
-    Operation.prototype.applyDelete = function(garbagecollect) {
-      if (garbagecollect == null) {
-        garbagecollect = true;
-      }
-      if (!this.garbage_collected) {
-        this.is_deleted = true;
-        if (garbagecollect) {
-          this.garbage_collected = true;
-          return HB.addToGarbageCollector(this);
-        }
-      }
-    };
-
-    Operation.prototype.cleanup = function() {
-      HB.removeOperation(this);
-      return this.deleteAllObservers();
-    };
-
-    Operation.prototype.setParent = function(parent) {
-      this.parent = parent;
-    };
-
-    Operation.prototype.getParent = function() {
-      return this.parent;
-    };
-
-    Operation.prototype.getUid = function() {
-      var map_uid;
-      if (this.uid.noOperation == null) {
-        return this.uid;
-      } else {
-        if (this.uid.alt != null) {
-          map_uid = this.uid.alt.cloneUid();
-          map_uid.sub = this.uid.sub;
-          map_uid.doSync = false;
-          return map_uid;
-        } else {
-          return void 0;
-        }
-      }
-    };
-
-    Operation.prototype.cloneUid = function() {
-      var n, uid, v, _ref;
-      uid = {};
-      _ref = this.getUid();
-      for (n in _ref) {
-        v = _ref[n];
-        uid[n] = v;
-      }
-      return uid;
-    };
-
-    Operation.prototype.dontSync = function() {
-      return this.uid.doSync = false;
-    };
-
-    Operation.prototype.execute = function() {
-      var l, _i, _len;
-      this.is_executed = true;
-      if (this.uid == null) {
-        this.uid = HB.getNextOperationIdentifier();
-      }
-      if (this.uid.noOperation == null) {
-        HB.addOperation(this);
-        for (_i = 0, _len = execution_listener.length; _i < _len; _i++) {
-          l = execution_listener[_i];
-          l(this._encode());
-        }
-      }
-      return this;
-    };
-
-    Operation.prototype.saveOperation = function(name, op) {
-      if ((op != null ? op.execute : void 0) != null) {
-        return this[name] = op;
-      } else if (op != null) {
-        if (this.unchecked == null) {
-          this.unchecked = {};
-        }
-        return this.unchecked[name] = op;
-      }
-    };
-
-    Operation.prototype.validateSavedOperations = function() {
-      var name, op, op_uid, success, uninstantiated, _ref;
-      uninstantiated = {};
-      success = this;
-      _ref = this.unchecked;
-      for (name in _ref) {
-        op_uid = _ref[name];
-        op = HB.getOperation(op_uid);
-        if (op) {
-          this[name] = op;
-        } else {
-          uninstantiated[name] = op_uid;
-          success = false;
-        }
-      }
-      delete this.unchecked;
-      if (!success) {
-        this.unchecked = uninstantiated;
-      }
-      return success;
-    };
-
-    return Operation;
-
-  })();
-  types.Delete = (function(_super) {
-    __extends(Delete, _super);
-
-    function Delete(uid, deletes) {
-      this.saveOperation('deletes', deletes);
-      Delete.__super__.constructor.call(this, uid);
-    }
-
-    Delete.prototype.type = "Delete";
-
-    Delete.prototype._encode = function() {
-      return {
-        'type': "Delete",
-        'uid': this.getUid(),
-        'deletes': this.deletes.getUid()
-      };
-    };
-
-    Delete.prototype.execute = function() {
-      var res;
-      if (this.validateSavedOperations()) {
-        res = Delete.__super__.execute.apply(this, arguments);
-        if (res) {
-          this.deletes.applyDelete(this);
-        }
-        return res;
-      } else {
-        return false;
-      }
-    };
-
-    return Delete;
-
-  })(types.Operation);
-  types.Delete.parse = function(o) {
-    var deletes_uid, uid;
-    uid = o['uid'], deletes_uid = o['deletes'];
-    return new this(uid, deletes_uid);
-  };
-  types.Insert = (function(_super) {
-    __extends(Insert, _super);
-
-    function Insert(uid, prev_cl, next_cl, origin, parent) {
-      this.saveOperation('parent', parent);
-      this.saveOperation('prev_cl', prev_cl);
-      this.saveOperation('next_cl', next_cl);
-      if (origin != null) {
-        this.saveOperation('origin', origin);
-      } else {
-        this.saveOperation('origin', prev_cl);
-      }
-      Insert.__super__.constructor.call(this, uid);
-    }
-
-    Insert.prototype.type = "Insert";
-
-    Insert.prototype.applyDelete = function(o) {
-      var callLater, garbagecollect, _ref;
-      if (this.deleted_by == null) {
-        this.deleted_by = [];
-      }
-      callLater = false;
-      if ((this.parent != null) && !this.isDeleted() && (o != null)) {
-        callLater = true;
-      }
-      if (o != null) {
-        this.deleted_by.push(o);
-      }
-      garbagecollect = false;
-      if (this.next_cl.isDeleted()) {
-        garbagecollect = true;
-      }
-      Insert.__super__.applyDelete.call(this, garbagecollect);
-      if (callLater) {
-        this.callOperationSpecificDeleteEvents(o);
-      }
-      if ((_ref = this.prev_cl) != null ? _ref.isDeleted() : void 0) {
-        return this.prev_cl.applyDelete();
-      }
-    };
-
-    Insert.prototype.cleanup = function() {
-      var d, o, _i, _len, _ref;
-      if (this.next_cl.isDeleted()) {
-        _ref = this.deleted_by;
-        for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-          d = _ref[_i];
-          d.cleanup();
-        }
-        o = this.next_cl;
-        while (o.type !== "Delimiter") {
-          if (o.origin === this) {
-            o.origin = this.prev_cl;
-          }
-          o = o.next_cl;
-        }
-        this.prev_cl.next_cl = this.next_cl;
-        this.next_cl.prev_cl = this.prev_cl;
-        return Insert.__super__.cleanup.apply(this, arguments);
-      }
-    };
-
-    Insert.prototype.getDistanceToOrigin = function() {
-      var d, o;
-      d = 0;
-      o = this.prev_cl;
-      while (true) {
-        if (this.origin === o) {
-          break;
-        }
-        d++;
-        o = o.prev_cl;
-      }
-      return d;
-    };
-
-    Insert.prototype.execute = function() {
-      var distance_to_origin, i, o;
-      if (!this.validateSavedOperations()) {
-        return false;
-      } else {
-        if (this.parent != null) {
-          if (this.prev_cl == null) {
-            this.prev_cl = this.parent.beginning;
-          }
-          if (this.origin == null) {
-            this.origin = this.parent.beginning;
-          }
-          if (this.next_cl == null) {
-            this.next_cl = this.parent.end;
-          }
-        }
-        if (this.prev_cl != null) {
-          distance_to_origin = this.getDistanceToOrigin();
-          o = this.prev_cl.next_cl;
-          i = distance_to_origin;
-          while (true) {
-            if (o !== this.next_cl) {
-              if (o.getDistanceToOrigin() === i) {
-                if (o.uid.creator < this.uid.creator) {
-                  this.prev_cl = o;
-                  distance_to_origin = i + 1;
-                } else {
-
-                }
-              } else if (o.getDistanceToOrigin() < i) {
-                if (i - distance_to_origin <= o.getDistanceToOrigin()) {
-                  this.prev_cl = o;
-                  distance_to_origin = i + 1;
-                } else {
-
-                }
-              } else {
-                break;
-              }
-              i++;
-              o = o.next_cl;
-            } else {
-              break;
-            }
-          }
-          this.next_cl = this.prev_cl.next_cl;
-          this.prev_cl.next_cl = this;
-          this.next_cl.prev_cl = this;
-        }
-        this.setParent(this.prev_cl.getParent());
-        Insert.__super__.execute.apply(this, arguments);
-        this.callOperationSpecificInsertEvents();
-        return this;
-      }
-    };
-
-    Insert.prototype.callOperationSpecificInsertEvents = function() {
-      var _ref;
-      return (_ref = this.parent) != null ? _ref.callEvent([
-        {
-          type: "insert",
-          position: this.getPosition(),
-          object: this.parent,
-          changedBy: this.uid.creator,
-          value: this.content
-        }
-      ]) : void 0;
-    };
-
-    Insert.prototype.callOperationSpecificDeleteEvents = function(o) {
-      return this.parent.callEvent([
-        {
-          type: "delete",
-          position: this.getPosition(),
-          object: this.parent,
-          length: 1,
-          changedBy: o.uid.creator
-        }
-      ]);
-    };
-
-    Insert.prototype.getPosition = function() {
-      var position, prev;
-      position = 0;
-      prev = this.prev_cl;
-      while (true) {
-        if (prev instanceof types.Delimiter) {
-          break;
-        }
-        if (!prev.isDeleted()) {
-          position++;
-        }
-        prev = prev.prev_cl;
-      }
-      return position;
-    };
-
-    return Insert;
-
-  })(types.Operation);
-  types.ImmutableObject = (function(_super) {
-    __extends(ImmutableObject, _super);
-
-    function ImmutableObject(uid, content) {
-      this.content = content;
-      ImmutableObject.__super__.constructor.call(this, uid);
-    }
-
-    ImmutableObject.prototype.type = "ImmutableObject";
-
-    ImmutableObject.prototype.val = function() {
-      return this.content;
-    };
-
-    ImmutableObject.prototype._encode = function() {
-      var json;
-      json = {
-        'type': this.type,
-        'uid': this.getUid(),
-        'content': this.content
-      };
-      return json;
-    };
-
-    return ImmutableObject;
-
-  })(types.Operation);
-  types.ImmutableObject.parse = function(json) {
-    var content, uid;
-    uid = json['uid'], content = json['content'];
-    return new this(uid, content);
-  };
-  types.Delimiter = (function(_super) {
-    __extends(Delimiter, _super);
-
-    function Delimiter(prev_cl, next_cl, origin) {
-      this.saveOperation('prev_cl', prev_cl);
-      this.saveOperation('next_cl', next_cl);
-      this.saveOperation('origin', prev_cl);
-      Delimiter.__super__.constructor.call(this, {
-        noOperation: true
-      });
-    }
-
-    Delimiter.prototype.type = "Delimiter";
-
-    Delimiter.prototype.applyDelete = function() {
-      var o;
-      Delimiter.__super__.applyDelete.call(this);
-      o = this.prev_cl;
-      while (o != null) {
-        o.applyDelete();
-        o = o.prev_cl;
-      }
-      return void 0;
-    };
-
-    Delimiter.prototype.cleanup = function() {
-      return Delimiter.__super__.cleanup.call(this);
-    };
-
-    Delimiter.prototype.execute = function() {
-      var _ref, _ref1;
-      if (((_ref = this.unchecked) != null ? _ref['next_cl'] : void 0) != null) {
-        return Delimiter.__super__.execute.apply(this, arguments);
-      } else if ((_ref1 = this.unchecked) != null ? _ref1['prev_cl'] : void 0) {
-        if (this.validateSavedOperations()) {
-          if (this.prev_cl.next_cl != null) {
-            throw new Error("Probably duplicated operations");
-          }
-          this.prev_cl.next_cl = this;
-          return Delimiter.__super__.execute.apply(this, arguments);
-        } else {
-          return false;
-        }
-      } else if ((this.prev_cl != null) && (this.prev_cl.next_cl == null)) {
-        delete this.prev_cl.unchecked.next_cl;
-        this.prev_cl.next_cl = this;
-        return Delimiter.__super__.execute.apply(this, arguments);
-      } else if ((this.prev_cl != null) || (this.next_cl != null) || true) {
-        return Delimiter.__super__.execute.apply(this, arguments);
-      }
-    };
-
-    Delimiter.prototype._encode = function() {
-      var _ref, _ref1;
-      return {
-        'type': this.type,
-        'uid': this.getUid(),
-        'prev': (_ref = this.prev_cl) != null ? _ref.getUid() : void 0,
-        'next': (_ref1 = this.next_cl) != null ? _ref1.getUid() : void 0
-      };
-    };
-
-    return Delimiter;
-
-  })(types.Operation);
-  types.Delimiter.parse = function(json) {
-    var next, prev, uid;
-    uid = json['uid'], prev = json['prev'], next = json['next'];
-    return new this(uid, prev, next);
-  };
-  return {
-    'types': types,
-    'execution_listener': execution_listener
-  };
-};

build/node/Types/JsonTypes.js

@@ -1,158 +0,0 @@
-var text_types_uninitialized,
-  __hasProp = {}.hasOwnProperty,
-  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
-
-text_types_uninitialized = require("./TextTypes");
-
-module.exports = function(HB) {
-  var text_types, types;
-  text_types = text_types_uninitialized(HB);
-  types = text_types.types;
-  types.Object = (function(_super) {
-    __extends(Object, _super);
-
-    function Object() {
-      return Object.__super__.constructor.apply(this, arguments);
-    }
-
-    Object.prototype.type = "Object";
-
-    Object.prototype.applyDelete = function() {
-      return Object.__super__.applyDelete.call(this);
-    };
-
-    Object.prototype.cleanup = function() {
-      return Object.__super__.cleanup.call(this);
-    };
-
-    Object.prototype.toJson = function(transform_to_value) {
-      var json, name, o, that, val;
-      if (transform_to_value == null) {
-        transform_to_value = false;
-      }
-      if ((this.bound_json == null) || (Object.observe == null) || true) {
-        val = this.val();
-        json = {};
-        for (name in val) {
-          o = val[name];
-          if (o instanceof types.Object) {
-            json[name] = o.toJson(transform_to_value);
-          } else if (o instanceof types.Array) {
-            json[name] = o.toJson(transform_to_value);
-          } else if (transform_to_value && o instanceof types.Operation) {
-            json[name] = o.val();
-          } else {
-            json[name] = o;
-          }
-        }
-        this.bound_json = json;
-        if (Object.observe != null) {
-          that = this;
-          Object.observe(this.bound_json, function(events) {
-            var event, _i, _len, _results;
-            _results = [];
-            for (_i = 0, _len = events.length; _i < _len; _i++) {
-              event = events[_i];
-              if ((event.changedBy == null) && (event.type === "add" || (event.type = "update"))) {
-                _results.push(that.val(event.name, event.object[event.name]));
-              } else {
-                _results.push(void 0);
-              }
-            }
-            return _results;
-          });
-          this.observe(function(events) {
-            var event, notifier, oldVal, _i, _len, _results;
-            _results = [];
-            for (_i = 0, _len = events.length; _i < _len; _i++) {
-              event = events[_i];
-              if (event.created_ !== HB.getUserId()) {
-                notifier = Object.getNotifier(that.bound_json);
-                oldVal = that.bound_json[event.name];
-                if (oldVal != null) {
-                  notifier.performChange('update', function() {
-                    return that.bound_json[event.name] = that.val(event.name);
-                  }, that.bound_json);
-                  _results.push(notifier.notify({
-                    object: that.bound_json,
-                    type: 'update',
-                    name: event.name,
-                    oldValue: oldVal,
-                    changedBy: event.changedBy
-                  }));
-                } else {
-                  notifier.performChange('add', function() {
-                    return that.bound_json[event.name] = that.val(event.name);
-                  }, that.bound_json);
-                  _results.push(notifier.notify({
-                    object: that.bound_json,
-                    type: 'add',
-                    name: event.name,
-                    oldValue: oldVal,
-                    changedBy: event.changedBy
-                  }));
-                }
-              } else {
-                _results.push(void 0);
-              }
-            }
-            return _results;
-          });
-        }
-      }
-      return this.bound_json;
-    };
-
-    Object.prototype.val = function(name, content) {
-      var args, i, o, type, _i, _ref;
-      if ((name != null) && arguments.length > 1) {
-        if ((content != null) && (content.constructor != null)) {
-          type = types[content.constructor.name];
-          if ((type != null) && (type.create != null)) {
-            args = [];
-            for (i = _i = 1, _ref = arguments.length; 1 <= _ref ? _i < _ref : _i > _ref; i = 1 <= _ref ? ++_i : --_i) {
-              args.push(arguments[i]);
-            }
-            o = type.create.apply(null, args);
-            return Object.__super__.val.call(this, name, o);
-          } else {
-            throw new Error("The " + content.constructor.name + "-type is not (yet) supported in Y.");
-          }
-        } else {
-          return Object.__super__.val.call(this, name, content);
-        }
-      } else {
-        return Object.__super__.val.call(this, name);
-      }
-    };
-
-    Object.prototype._encode = function() {
-      return {
-        'type': this.type,
-        'uid': this.getUid()
-      };
-    };
-
-    return Object;
-
-  })(types.MapManager);
-  types.Object.parse = function(json) {
-    var uid;
-    uid = json['uid'];
-    return new this(uid);
-  };
-  types.Object.create = function(content, mutable) {
-    var json, n, o;
-    json = new types.Object().execute();
-    for (n in content) {
-      o = content[n];
-      json.val(n, o, mutable);
-    }
-    return json;
-  };
-  types.Number = {};
-  types.Number.create = function(content) {
-    return content;
-  };
-  return text_types;
-};

build/node/Types/StructuredTypes.js

@@ -1,353 +0,0 @@
-var basic_types_uninitialized,
-  __hasProp = {}.hasOwnProperty,
-  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
-
-basic_types_uninitialized = require("./BasicTypes");
-
-module.exports = function(HB) {
-  var basic_types, types;
-  basic_types = basic_types_uninitialized(HB);
-  types = basic_types.types;
-  types.MapManager = (function(_super) {
-    __extends(MapManager, _super);
-
-    function MapManager(uid) {
-      this.map = {};
-      MapManager.__super__.constructor.call(this, uid);
-    }
-
-    MapManager.prototype.type = "MapManager";
-
-    MapManager.prototype.applyDelete = function() {
-      var name, p, _ref;
-      _ref = this.map;
-      for (name in _ref) {
-        p = _ref[name];
-        p.applyDelete();
-      }
-      return MapManager.__super__.applyDelete.call(this);
-    };
-
-    MapManager.prototype.cleanup = function() {
-      return MapManager.__super__.cleanup.call(this);
-    };
-
-    MapManager.prototype.val = function(name, content) {
-      var o, prop, result, _ref;
-      if (arguments.length > 1) {
-        this.retrieveSub(name).replace(content);
-        return this;
-      } else if (name != null) {
-        prop = this.map[name];
-        if ((prop != null) && !prop.isContentDeleted()) {
-          return prop.val();
-        } else {
-          return void 0;
-        }
-      } else {
-        result = {};
-        _ref = this.map;
-        for (name in _ref) {
-          o = _ref[name];
-          if (!o.isContentDeleted()) {
-            result[name] = o.val();
-          }
-        }
-        return result;
-      }
-    };
-
-    MapManager.prototype["delete"] = function(name) {
-      var _ref;
-      if ((_ref = this.map[name]) != null) {
-        _ref.deleteContent();
-      }
-      return this;
-    };
-
-    MapManager.prototype.retrieveSub = function(property_name) {
-      var event_properties, event_this, rm, rm_uid;
-      if (this.map[property_name] == null) {
-        event_properties = {
-          name: property_name
-        };
-        event_this = this;
-        rm_uid = {
-          noOperation: true,
-          sub: property_name,
-          alt: this
-        };
-        rm = new types.ReplaceManager(event_properties, event_this, rm_uid);
-        this.map[property_name] = rm;
-        rm.setParent(this, property_name);
-        rm.execute();
-      }
-      return this.map[property_name];
-    };
-
-    return MapManager;
-
-  })(types.Operation);
-  types.ListManager = (function(_super) {
-    __extends(ListManager, _super);
-
-    function ListManager(uid) {
-      this.beginning = new types.Delimiter(void 0, void 0);
-      this.end = new types.Delimiter(this.beginning, void 0);
-      this.beginning.next_cl = this.end;
-      this.beginning.execute();
-      this.end.execute();
-      ListManager.__super__.constructor.call(this, uid);
-    }
-
-    ListManager.prototype.type = "ListManager";
-
-    ListManager.prototype.execute = function() {
-      if (this.validateSavedOperations()) {
-        this.beginning.setParent(this);
-        this.end.setParent(this);
-        return ListManager.__super__.execute.apply(this, arguments);
-      } else {
-        return false;
-      }
-    };
-
-    ListManager.prototype.getLastOperation = function() {
-      return this.end.prev_cl;
-    };
-
-    ListManager.prototype.getFirstOperation = function() {
-      return this.beginning.next_cl;
-    };
-
-    ListManager.prototype.toArray = function() {
-      var o, result;
-      o = this.beginning.next_cl;
-      result = [];
-      while (o !== this.end) {
-        result.push(o);
-        o = o.next_cl;
-      }
-      return result;
-    };
-
-    ListManager.prototype.getOperationByPosition = function(position) {
-      var o;
-      o = this.beginning;
-      while (true) {
-        if (o instanceof types.Delimiter && (o.prev_cl != null)) {
-          o = o.prev_cl;
-          while (o.isDeleted() || !(o instanceof types.Delimiter)) {
-            o = o.prev_cl;
-          }
-          break;
-        }
-        if (position <= 0 && !o.isDeleted()) {
-          break;
-        }
-        o = o.next_cl;
-        if (!o.isDeleted()) {
-          position -= 1;
-        }
-      }
-      return o;
-    };
-
-    return ListManager;
-
-  })(types.Operation);
-  types.ReplaceManager = (function(_super) {
-    __extends(ReplaceManager, _super);
-
-    function ReplaceManager(event_properties, event_this, uid, beginning, end) {
-      this.event_properties = event_properties;
-      this.event_this = event_this;
-      if (this.event_properties['object'] == null) {
-        this.event_properties['object'] = this.event_this;
-      }
-      ReplaceManager.__super__.constructor.call(this, uid, beginning, end);
-    }
-
-    ReplaceManager.prototype.type = "ReplaceManager";
-
-    ReplaceManager.prototype.applyDelete = function() {
-      var o;
-      o = this.beginning;
-      while (o != null) {
-        o.applyDelete();
-        o = o.next_cl;
-      }
-      return ReplaceManager.__super__.applyDelete.call(this);
-    };
-
-    ReplaceManager.prototype.cleanup = function() {
-      return ReplaceManager.__super__.cleanup.call(this);
-    };
-
-    ReplaceManager.prototype.callEventDecorator = function(events) {
-      var event, name, prop, _i, _len, _ref;
-      if (!this.isDeleted()) {
-        for (_i = 0, _len = events.length; _i < _len; _i++) {
-          event = events[_i];
-          _ref = this.event_properties;
-          for (name in _ref) {
-            prop = _ref[name];
-            event[name] = prop;
-          }
-        }
-        this.event_this.callEvent(events);
-      }
-      return void 0;
-    };
-
-    ReplaceManager.prototype.replace = function(content, replaceable_uid) {
-      var o, relp;
-      o = this.getLastOperation();
-      relp = (new types.Replaceable(content, this, replaceable_uid, o, o.next_cl)).execute();
-      return void 0;
-    };
-
-    ReplaceManager.prototype.isContentDeleted = function() {
-      return this.getLastOperation().isDeleted();
-    };
-
-    ReplaceManager.prototype.deleteContent = function() {
-      (new types.Delete(void 0, this.getLastOperation().uid)).execute();
-      return void 0;
-    };
-
-    ReplaceManager.prototype.val = function() {
-      var o;
-      o = this.getLastOperation();
-      return typeof o.val === "function" ? o.val() : void 0;
-    };
-
-    ReplaceManager.prototype._encode = function() {
-      var json;
-      json = {
-        'type': this.type,
-        'uid': this.getUid(),
-        'beginning': this.beginning.getUid(),
-        'end': this.end.getUid()
-      };
-      return json;
-    };
-
-    return ReplaceManager;
-
-  })(types.ListManager);
-  types.Replaceable = (function(_super) {
-    __extends(Replaceable, _super);
-
-    function Replaceable(content, parent, uid, prev, next, origin, is_deleted) {
-      if ((content != null) && (content.creator != null)) {
-        this.saveOperation('content', content);
-      } else {
-        this.content = content;
-      }
-      this.saveOperation('parent', parent);
-      Replaceable.__super__.constructor.call(this, uid, prev, next, origin);
-      this.is_deleted = is_deleted;
-    }
-
-    Replaceable.prototype.type = "Replaceable";
-
-    Replaceable.prototype.val = function() {
-      return this.content;
-    };
-
-    Replaceable.prototype.applyDelete = function() {
-      var res, _base, _base1, _base2;
-      res = Replaceable.__super__.applyDelete.apply(this, arguments);
-      if (this.content != null) {
-        if (this.next_cl.type !== "Delimiter") {
-          if (typeof (_base = this.content).deleteAllObservers === "function") {
-            _base.deleteAllObservers();
-          }
-        }
-        if (typeof (_base1 = this.content).applyDelete === "function") {
-          _base1.applyDelete();
-        }
-        if (typeof (_base2 = this.content).dontSync === "function") {
-          _base2.dontSync();
-        }
-      }
-      this.content = null;
-      return res;
-    };
-
-    Replaceable.prototype.cleanup = function() {
-      return Replaceable.__super__.cleanup.apply(this, arguments);
-    };
-
-    Replaceable.prototype.callOperationSpecificInsertEvents = function() {
-      var old_value;
-      if (this.next_cl.type === "Delimiter" && this.prev_cl.type !== "Delimiter") {
-        if (!this.is_deleted) {
-          old_value = this.prev_cl.content;
-          this.parent.callEventDecorator([
-            {
-              type: "update",
-              changedBy: this.uid.creator,
-              oldValue: old_value
-            }
-          ]);
-        }
-        this.prev_cl.applyDelete();
-      } else if (this.next_cl.type !== "Delimiter") {
-        this.applyDelete();
-      } else {
-        this.parent.callEventDecorator([
-          {
-            type: "add",
-            changedBy: this.uid.creator
-          }
-        ]);
-      }
-      return void 0;
-    };
-
-    Replaceable.prototype.callOperationSpecificDeleteEvents = function(o) {
-      if (this.next_cl.type === "Delimiter") {
-        return this.parent.callEventDecorator([
-          {
-            type: "delete",
-            changedBy: o.uid.creator,
-            oldValue: this.content
-          }
-        ]);
-      }
-    };
-
-    Replaceable.prototype._encode = function() {
-      var json;
-      json = {
-        'type': this.type,
-        'parent': this.parent.getUid(),
-        'prev': this.prev_cl.getUid(),
-        'next': this.next_cl.getUid(),
-        'origin': this.origin.getUid(),
-        'uid': this.getUid(),
-        'is_deleted': this.is_deleted
-      };
-      if (this.content instanceof types.Operation) {
-        json['content'] = this.content.getUid();
-      } else {
-        if ((this.content != null) && (this.content.creator != null)) {
-          throw new Error("You must not set creator here!");
-        }
-        json['content'] = this.content;
-      }
-      return json;
-    };
-
-    return Replaceable;
-
-  })(types.Insert);
-  types.Replaceable.parse = function(json) {
-    var content, is_deleted, next, origin, parent, prev, uid;
-    content = json['content'], parent = json['parent'], uid = json['uid'], prev = json['prev'], next = json['next'], origin = json['origin'], is_deleted = json['is_deleted'];
-    return new this(content, parent, uid, prev, next, origin, is_deleted);
-  };
-  return basic_types;
-};

build/node/Types/TextTypes.js

@@ -1,561 +0,0 @@
-var structured_types_uninitialized,
-  __hasProp = {}.hasOwnProperty,
-  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
-
-structured_types_uninitialized = require("./StructuredTypes");
-
-module.exports = function(HB) {
-  var parser, structured_types, types;
-  structured_types = structured_types_uninitialized(HB);
-  types = structured_types.types;
-  parser = structured_types.parser;
-  types.TextInsert = (function(_super) {
-    __extends(TextInsert, _super);
-
-    function TextInsert(content, uid, prev, next, origin, parent) {
-      if (content != null ? content.creator : void 0) {
-        this.saveOperation('content', content);
-      } else {
-        this.content = content;
-      }
-      TextInsert.__super__.constructor.call(this, uid, prev, next, origin, parent);
-    }
-
-    TextInsert.prototype.type = "TextInsert";
-
-    TextInsert.prototype.getLength = function() {
-      if (this.isDeleted()) {
-        return 0;
-      } else {
-        return this.content.length;
-      }
-    };
-
-    TextInsert.prototype.applyDelete = function() {
-      TextInsert.__super__.applyDelete.apply(this, arguments);
-      if (this.content instanceof types.Operation) {
-        this.content.applyDelete();
-      }
-      return this.content = null;
-    };
-
-    TextInsert.prototype.execute = function() {
-      if (!this.validateSavedOperations()) {
-        return false;
-      } else {
-        if (this.content instanceof types.Operation) {
-          this.content.insert_parent = this;
-        }
-        return TextInsert.__super__.execute.call(this);
-      }
-    };
-
-    TextInsert.prototype.val = function(current_position) {
-      if (this.isDeleted() || (this.content == null)) {
-        return "";
-      } else {
-        return this.content;
-      }
-    };
-
-    TextInsert.prototype._encode = function() {
-      var json, _ref;
-      json = {
-        'type': this.type,
-        'uid': this.getUid(),
-        'prev': this.prev_cl.getUid(),
-        'next': this.next_cl.getUid(),
-        'origin': this.origin.getUid(),
-        'parent': this.parent.getUid()
-      };
-      if (((_ref = this.content) != null ? _ref.getUid : void 0) != null) {
-        json['content'] = this.content.getUid();
-      } else {
-        json['content'] = this.content;
-      }
-      return json;
-    };
-
-    return TextInsert;
-
-  })(types.Insert);
-  types.TextInsert.parse = function(json) {
-    var content, next, origin, parent, prev, uid;
-    content = json['content'], uid = json['uid'], prev = json['prev'], next = json['next'], origin = json['origin'], parent = json['parent'];
-    return new types.TextInsert(content, uid, prev, next, origin, parent);
-  };
-  types.Array = (function(_super) {
-    __extends(Array, _super);
-
-    function Array() {
-      return Array.__super__.constructor.apply(this, arguments);
-    }
-
-    Array.prototype.type = "Array";
-
-    Array.prototype.applyDelete = function() {
-      var o;
-      o = this.end;
-      while (o != null) {
-        o.applyDelete();
-        o = o.prev_cl;
-      }
-      return Array.__super__.applyDelete.call(this);
-    };
-
-    Array.prototype.cleanup = function() {
-      return Array.__super__.cleanup.call(this);
-    };
-
-    Array.prototype.toJson = function(transform_to_value) {
-      var i, o, val, _i, _len, _results;
-      if (transform_to_value == null) {
-        transform_to_value = false;
-      }
-      val = this.val();
-      _results = [];
-      for (o = _i = 0, _len = val.length; _i < _len; o = ++_i) {
-        i = val[o];
-        if (o instanceof types.Object) {
-          _results.push(o.toJson(transform_to_value));
-        } else if (o instanceof types.Array) {
-          _results.push(o.toJson(transform_to_value));
-        } else if (transform_to_value && o instanceof types.Operation) {
-          _results.push(o.val());
-        } else {
-          _results.push(o);
-        }
-      }
-      return _results;
-    };
-
-    Array.prototype.val = function(pos) {
-      var o, result;
-      if (pos != null) {
-        o = this.getOperationByPosition(pos + 1);
-        if (!(o instanceof types.Delimiter)) {
-          return o.val();
-        } else {
-          throw new Error("this position does not exist");
-        }
-      } else {
-        o = this.beginning.next_cl;
-        result = [];
-        while (o !== this.end) {
-          if (!o.isDeleted()) {
-            result.push(o.val());
-          }
-          o = o.next_cl;
-        }
-        return result;
-      }
-    };
-
-    Array.prototype.push = function(content) {
-      return this.insertAfter(this.end.prev_cl, content);
-    };
-
-    Array.prototype.insertAfter = function(left, content, options) {
-      var c, createContent, right, tmp, _i, _len;
-      createContent = function(content, options) {
-        var type;
-        if ((content != null) && (content.constructor != null)) {
-          type = types[content.constructor.name];
-          if ((type != null) && (type.create != null)) {
-            return type.create(content, options);
-          } else {
-            throw new Error("The " + content.constructor.name + "-type is not (yet) supported in Y.");
-          }
-        } else {
-          return content;
-        }
-      };
-      right = left.next_cl;
-      while (right.isDeleted()) {
-        right = right.next_cl;
-      }
-      left = right.prev_cl;
-      if (content instanceof types.Operation) {
-        (new types.TextInsert(content, void 0, left, right)).execute();
-      } else {
-        for (_i = 0, _len = content.length; _i < _len; _i++) {
-          c = content[_i];
-          tmp = (new types.TextInsert(createContent(c, options), void 0, left, right)).execute();
-          left = tmp;
-        }
-      }
-      return this;
-    };
-
-    Array.prototype.insert = function(position, content, options) {
-      var ith;
-      ith = this.getOperationByPosition(position);
-      return this.insertAfter(ith, [content], options);
-    };
-
-    Array.prototype["delete"] = function(position, length) {
-      var d, delete_ops, i, o, _i;
-      o = this.getOperationByPosition(position + 1);
-      delete_ops = [];
-      for (i = _i = 0; 0 <= length ? _i < length : _i > length; i = 0 <= length ? ++_i : --_i) {
-        if (o instanceof types.Delimiter) {
-          break;
-        }
-        d = (new types.Delete(void 0, o)).execute();
-        o = o.next_cl;
-        while ((!(o instanceof types.Delimiter)) && o.isDeleted()) {
-          o = o.next_cl;
-        }
-        delete_ops.push(d._encode());
-      }
-      return this;
-    };
-
-    Array.prototype._encode = function() {
-      var json;
-      json = {
-        'type': this.type,
-        'uid': this.getUid()
-      };
-      return json;
-    };
-
-    return Array;
-
-  })(types.ListManager);
-  types.Array.parse = function(json) {
-    var uid;
-    uid = json['uid'];
-    return new this(uid);
-  };
-  types.Array.create = function(content, mutable) {
-    var ith, list;
-    if (mutable === "mutable") {
-      list = new types.Array().execute();
-      ith = list.getOperationByPosition(0);
-      list.insertAfter(ith, content);
-      return list;
-    } else if ((mutable == null) || (mutable === "immutable")) {
-      return content;
-    } else {
-      throw new Error("Specify either \"mutable\" or \"immutable\"!!");
-    }
-  };
-  types.String = (function(_super) {
-    __extends(String, _super);
-
-    function String(uid) {
-      this.textfields = [];
-      String.__super__.constructor.call(this, uid);
-    }
-
-    String.prototype.type = "String";
-
-    String.prototype.val = function() {
-      var c, o;
-      c = (function() {
-        var _i, _len, _ref, _results;
-        _ref = this.toArray();
-        _results = [];
-        for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-          o = _ref[_i];
-          if (o.val != null) {
-            _results.push(o.val());
-          } else {
-            _results.push("");
-          }
-        }
-        return _results;
-      }).call(this);
-      return c.join('');
-    };
-
-    String.prototype.toString = function() {
-      return this.val();
-    };
-
-    String.prototype.insert = function(position, content, options) {
-      var ith;
-      ith = this.getOperationByPosition(position);
-      return this.insertAfter(ith, content, options);
-    };
-
-    String.prototype.bind = function(textfield, dom_root) {
-      var createRange, creator_token, t, word, writeContent, writeRange, _i, _len, _ref;
-      if (dom_root == null) {
-        dom_root = window;
-      }
-      if (dom_root.getSelection == null) {
-        dom_root = window;
-      }
-      _ref = this.textfields;
-      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
-        t = _ref[_i];
-        if (t === textfield) {
-          return;
-        }
-      }
-      creator_token = false;
-      word = this;
-      textfield.value = this.val();
-      this.textfields.push(textfield);
-      if ((textfield.selectionStart != null) && (textfield.setSelectionRange != null)) {
-        createRange = function(fix) {
-          var left, right;
-          left = textfield.selectionStart;
-          right = textfield.selectionEnd;
-          if (fix != null) {
-            left = fix(left);
-            right = fix(right);
-          }
-          return {
-            left: left,
-            right: right
-          };
-        };
-        writeRange = function(range) {
-          writeContent(word.val());
-          return textfield.setSelectionRange(range.left, range.right);
-        };
-        writeContent = function(content) {
-          return textfield.value = content;
-        };
-      } else {
-        createRange = function(fix) {
-          var clength, edited_element, range, s;
-          range = {};
-          s = dom_root.getSelection();
-          clength = textfield.textContent.length;
-          range.left = Math.min(s.anchorOffset, clength);
-          range.right = Math.min(s.focusOffset, clength);
-          if (fix != null) {
-            range.left = fix(range.left);
-            range.right = fix(range.right);
-          }
-          edited_element = s.focusNode;
-          if (edited_element === textfield || edited_element === textfield.childNodes[0]) {
-            range.isReal = true;
-          } else {
-            range.isReal = false;
-          }
-          return range;
-        };
-        writeRange = function(range) {
-          var r, s, textnode;
-          writeContent(word.val());
-          textnode = textfield.childNodes[0];
-          if (range.isReal && (textnode != null)) {
-            if (range.left < 0) {
-              range.left = 0;
-            }
-            range.right = Math.max(range.left, range.right);
-            if (range.right > textnode.length) {
-              range.right = textnode.length;
-            }
-            range.left = Math.min(range.left, range.right);
-            r = document.createRange();
-            r.setStart(textnode, range.left);
-            r.setEnd(textnode, range.right);
-            s = window.getSelection();
-            s.removeAllRanges();
-            return s.addRange(r);
-          }
-        };
-        writeContent = function(content) {
-          var append;
-          append = "";
-          if (content[content.length - 1] === " ") {
-            content = content.slice(0, content.length - 1);
-            append = '&nbsp;';
-          }
-          textfield.textContent = content;
-          return textfield.innerHTML += append;
-        };
-      }
-      writeContent(this.val());
-      this.observe(function(events) {
-        var event, fix, o_pos, r, _j, _len1, _results;
-        _results = [];
-        for (_j = 0, _len1 = events.length; _j < _len1; _j++) {
-          event = events[_j];
-          if (!creator_token) {
-            if (event.type === "insert") {
-              o_pos = event.position;
-              fix = function(cursor) {
-                if (cursor <= o_pos) {
-                  return cursor;
-                } else {
-                  cursor += 1;
-                  return cursor;
-                }
-              };
-              r = createRange(fix);
-              _results.push(writeRange(r));
-            } else if (event.type === "delete") {
-              o_pos = event.position;
-              fix = function(cursor) {
-                if (cursor < o_pos) {
-                  return cursor;
-                } else {
-                  cursor -= 1;
-                  return cursor;
-                }
-              };
-              r = createRange(fix);
-              _results.push(writeRange(r));
-            } else {
-              _results.push(void 0);
-            }
-          } else {
-            _results.push(void 0);
-          }
-        }
-        return _results;
-      });
-      textfield.onkeypress = function(event) {
-        var char, diff, pos, r;
-        if (word.is_deleted) {
-          textfield.onkeypress = null;
-          return true;
-        }
-        creator_token = true;
-        char = null;
-        if (event.key != null) {
-          if (event.charCode === 32) {
-            char = " ";
-          } else if (event.keyCode === 13) {
-            char = '\n';
-          } else {
-            char = event.key;
-          }
-        } else {
-          char = window.String.fromCharCode(event.keyCode);
-        }
-        if (char.length > 1) {
-          return true;
-        } else if (char.length > 0) {
-          r = createRange();
-          pos = Math.min(r.left, r.right);
-          diff = Math.abs(r.right - r.left);
-          word["delete"](pos, diff);
-          word.insert(pos, char);
-          r.left = pos + char.length;
-          r.right = r.left;
-          writeRange(r);
-        }
-        event.preventDefault();
-        creator_token = false;
-        return false;
-      };
-      textfield.onpaste = function(event) {
-        if (word.is_deleted) {
-          textfield.onpaste = null;
-          return true;
-        }
-        return event.preventDefault();
-      };
-      textfield.oncut = function(event) {
-        if (word.is_deleted) {
-          textfield.oncut = null;
-          return true;
-        }
-        return event.preventDefault();
-      };
-      return textfield.onkeydown = function(event) {
-        var del_length, diff, new_pos, pos, r, val;
-        creator_token = true;
-        if (word.is_deleted) {
-          textfield.onkeydown = null;
-          return true;
-        }
-        r = createRange();
-        pos = Math.min(r.left, r.right, word.val().length);
-        diff = Math.abs(r.left - r.right);
-        if ((event.keyCode != null) && event.keyCode === 8) {
-          if (diff > 0) {
-            word["delete"](pos, diff);
-            r.left = pos;
-            r.right = pos;
-            writeRange(r);
-          } else {
-            if ((event.ctrlKey != null) && event.ctrlKey) {
-              val = word.val();
-              new_pos = pos;
-              del_length = 0;
-              if (pos > 0) {
-                new_pos--;
-                del_length++;
-              }
-              while (new_pos > 0 && val[new_pos] !== " " && val[new_pos] !== '\n') {
-                new_pos--;
-                del_length++;
-              }
-              word["delete"](new_pos, pos - new_pos);
-              r.left = new_pos;
-              r.right = new_pos;
-              writeRange(r);
-            } else {
-              if (pos > 0) {
-                word["delete"](pos - 1, 1);
-                r.left = pos - 1;
-                r.right = pos - 1;
-                writeRange(r);
-              }
-            }
-          }
-          event.preventDefault();
-          creator_token = false;
-          return false;
-        } else if ((event.keyCode != null) && event.keyCode === 46) {
-          if (diff > 0) {
-            word["delete"](pos, diff);
-            r.left = pos;
-            r.right = pos;
-            writeRange(r);
-          } else {
-            word["delete"](pos, 1);
-            r.left = pos;
-            r.right = pos;
-            writeRange(r);
-          }
-          event.preventDefault();
-          creator_token = false;
-          return false;
-        } else {
-          creator_token = false;
-          return true;
-        }
-      };
-    };
-
-    String.prototype._encode = function() {
-      var json;
-      json = {
-        'type': this.type,
-        'uid': this.getUid()
-      };
-      return json;
-    };
-
-    return String;
-
-  })(types.Array);
-  types.String.parse = function(json) {
-    var uid;
-    uid = json['uid'];
-    return new this(uid);
-  };
-  types.String.create = function(content, mutable) {
-    var word;
-    if (mutable === "mutable") {
-      word = new types.String().execute();
-      word.insert(0, content);
-      return word;
-    } else if ((mutable == null) || (mutable === "immutable")) {
-      return content;
-    } else {
-      throw new Error("Specify either \"mutable\" or \"immutable\"!!");
-    }
-  };
-  return structured_types;
-};

build/node/y-object.js

@@ -1,92 +0,0 @@
-var Y, bindToChildren;
-
-Y = require('./y');
-
-bindToChildren = function(that) {
-  var attr, i, _i, _ref;
-  for (i = _i = 0, _ref = that.children.length; 0 <= _ref ? _i < _ref : _i > _ref; i = 0 <= _ref ? ++_i : --_i) {
-    attr = that.children.item(i);
-    if (attr.name != null) {
-      attr.val = that.val.val(attr.name);
-    }
-  }
-  return that.val.observe(function(events) {
-    var event, newVal, _j, _len, _results;
-    _results = [];
-    for (_j = 0, _len = events.length; _j < _len; _j++) {
-      event = events[_j];
-      if (event.name != null) {
-        _results.push((function() {
-          var _k, _ref1, _results1;
-          _results1 = [];
-          for (i = _k = 0, _ref1 = that.children.length; 0 <= _ref1 ? _k < _ref1 : _k > _ref1; i = 0 <= _ref1 ? ++_k : --_k) {
-            attr = that.children.item(i);
-            if ((attr.name != null) && attr.name === event.name) {
-              newVal = that.val.val(attr.name);
-              if (attr.val !== newVal) {
-                _results1.push(attr.val = newVal);
-              } else {
-                _results1.push(void 0);
-              }
-            } else {
-              _results1.push(void 0);
-            }
-          }
-          return _results1;
-        })());
-      } else {
-        _results.push(void 0);
-      }
-    }
-    return _results;
-  });
-};
-
-Polymer("y-object", {
-  ready: function() {
-    if (this.connector != null) {
-      this.val = new Y(this.connector);
-      return bindToChildren(this);
-    } else if (this.val != null) {
-      return bindToChildren(this);
-    }
-  },
-  valChanged: function() {
-    if ((this.val != null) && this.val.type === "Object") {
-      return bindToChildren(this);
-    }
-  },
-  connectorChanged: function() {
-    if (this.val == null) {
-      this.val = new Y(this.connector);
-      return bindToChildren(this);
-    }
-  }
-});
-
-Polymer("y-property", {
-  ready: function() {
-    if ((this.val != null) && (this.name != null)) {
-      if (this.val.constructor === Object) {
-        this.val = this.parentElement.val(this.name, this.val).val(this.name);
-      } else if (typeof this.val === "string") {
-        this.parentElement.val(this.name, this.val);
-      }
-      if (this.val.type === "Object") {
-        return bindToChildren(this);
-      }
-    }
-  },
-  valChanged: function() {
-    var _ref;
-    if ((this.val != null) && (this.name != null)) {
-      if (this.val.constructor === Object) {
-        return this.val = this.parentElement.val.val(this.name, this.val).val(this.name);
-      } else if (this.val.type === "Object") {
-        return bindToChildren(this);
-      } else if ((((_ref = this.parentElement.val) != null ? _ref.val : void 0) != null) && this.val !== this.parentElement.val.val(this.name)) {
-        return this.parentElement.val.val(this.name, this.val);
-      }
-    }
-  }
-});

build/node/y.js

@@ -1,54 +0,0 @@
-var Engine, HistoryBuffer, adaptConnector, createY, json_types_uninitialized,
-  __hasProp = {}.hasOwnProperty,
-  __extends = function(child, parent) { for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; } function ctor() { this.constructor = child; } ctor.prototype = parent.prototype; child.prototype = new ctor(); child.__super__ = parent.prototype; return child; };
-
-json_types_uninitialized = require("./Types/JsonTypes");
-
-HistoryBuffer = require("./HistoryBuffer");
-
-Engine = require("./Engine");
-
-adaptConnector = require("./ConnectorAdapter");
-
-createY = function(connector) {
-  var HB, Y, type_manager, types, user_id;
-  user_id = null;
-  if (connector.user_id != null) {
-    user_id = connector.user_id;
-  } else {
-    user_id = "_temp";
-    connector.on_user_id_set = function(id) {
-      user_id = id;
-      return HB.resetUserId(id);
-    };
-  }
-  HB = new HistoryBuffer(user_id);
-  type_manager = json_types_uninitialized(HB);
-  types = type_manager.types;
-  Y = (function(_super) {
-    __extends(Y, _super);
-
-    function Y() {
-      this.connector = connector;
-      this.HB = HB;
-      this.types = types;
-      this.engine = new Engine(this.HB, type_manager.types);
-      adaptConnector(this.connector, this.engine, this.HB, type_manager.execution_listener);
-      Y.__super__.constructor.apply(this, arguments);
-    }
-
-    Y.prototype.getConnector = function() {
-      return this.connector;
-    };
-
-    return Y;
-
-  })(types.Object);
-  return new Y(HB.getReservedUniqueIdentifier()).execute();
-};
-
-module.exports = createY;
-
-if ((typeof window !== "undefined" && window !== null) && (window.Y == null)) {
-  window.Y = createY;
-}

build/test/index.html

@@ -1,27 +0,0 @@
-<html>
-<head>
-  <meta charset="utf-8">
-  <title>Test Yjs!</title>
-    <link rel="stylesheet" href="../../node_modules/mocha/mocha.css" />
-</head>
-<body>
-  <div id="mocha"></div>
-  <div id="test_dom" test_attribute="the test" class="stuffy" style="color: blue"><p id="replaceme">replace me</p><p id="removeme">remove me</p><p>This is a test object for <b>XmlFramework</b></p><span class="span_element"><p>span</p></span></div>
-  <script src="../../node_modules/mocha/mocha.js" class="awesome"></script>
-  <script>
-    mocha.setup('bdd');
-    mocha.ui('bdd');
-    mocha.reporter('html');
-  </script>
-  <script src="Text_test.js"></script>
-  <script src="Json_test.js"></script>
-  <!--script src="Xml_test_browser.js"></script-->
-  <script>
-    //mocha.checkLeaks();
-    //mocha.run();
-    window.onerror = null;
-    if (window.mochaPhantomJS) { mochaPhantomJS.run(); }
-    else { mocha.run(); }
-  </script>
-</body>
-</html>

examples/README.md

@@ -1,5 +0,0 @@
-# Examples
-
-Here you find some (hopefully) usefull examples on how to use Yjs!
-
-Feel free to use the code of the examples in your own project. They include basic examples how to use Yjs.

examples/WebRTC-Polymer/index.html

@@ -1,15 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <meta charset=utf-8 />
-    <title>Y Example</title>
-    <script src="../../../webcomponentsjs/webcomponents.min.js"></script>
-    <link rel="import" href="../../../polymer/polymer.html">
-
-    <link rel="import" href="y-test.html">
-  </head>
-  <body>
-    <y-test></y-test>
-    <p> This example tests a few things like Late Join, the synchronization process while editing, and if the Connector and Yjs work together as Polymer elements. you can use this example as a starting point for your own Polymer project too. </p>
-  </body>
-</html>

examples/WebRTC-Polymer/y-test.html

@@ -1,55 +0,0 @@
-<link rel="import" href="../../build/browser/y-object.html">
-<link rel="import" href="../../../y-webrtc/build/browser/y-webrtc.html">
-<link rel="import" href="../../../paper-slider/paper-slider.html">
-
-<polymer-element name="y-test" attributes="y connector stuff">
-  <template>
-    <h1 id="text" contentEditable> Check this out !</h1>
-    <y-webrtc id="connector" connector={{connector}} room="testy-webrtc-polymer" debug="true"></y-webrtc>
-    <y-object connector={{connector}} val={{y}}>
-      <y-property name="slider" val={{slider}}>
-      </y-property>
-      <y-property name="stuff" val={{stuff}}>
-        <y-property id="otherstuff" name="otherstuff" val={{otherstuff}}>
-        </y-property>
-      </y-property>
-    </y-object>
-    <y-object val={{otherstuff}}>
-      <y-property name="nostuff" val={{nostuff}}>
-      </y-property>
-    </y-object>
-    <paper-slider min="0" max="200" immediateValue={{slider}}></paper-slider>
-  </template>
-  <script>
-  Polymer({
-    ready: function(){
-      window.y_stuff_property = this.$.otherstuff;
-      this.y.val("slider",50)
-      var that = this;
-      this.connector.whenSynced(function(){
-        if(that.y.val("text") == null){
-          that.y.val("text","stuff","mutable");
-        }
-        that.y.val("text").bind(that.$.text,that.shadowRoot)
-      })
-
-      // Everything is initialized. Lets test stuff!
-      window.y_test = this;
-      window.y_test.y.val("stuff",{otherstuff:{nostuff:"this is no stuff"}})
-      setTimeout(function(){
-        var res = y_test.y.val("stuff");
-        if(!(y_test.nostuff === "this is no stuff")){
-          console.log("Deep inherit doesn't work!")
-        }
-        window.y_stuff_property.val = {nostuff: "this is also no stuff"};
-        setTimeout(function(){
-          if(!(y_test.nostuff === "this is also no stuff")){
-            console.log("Element val overwrite doesn't work")
-          }
-          console.log("Everything is fine :)");
-        },500)
-      },500);
-    }
-  })
-  </script>
-</polymer-element>

examples/WebRTC/index.html

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-        <meta charset=utf-8 />
-        <title>Y Example</title>
-        <script src="../../build/browser/y.js"></script>
-        <script src="../../../y-webrtc/build/browser/y-webrtc.js"></script>
-        <script src="./index.js"></script>
-</head>
-<body>
-<h1 contentEditable> yjs Tutorial</h1>
-<p> Collaborative Json editing with <a href="https://github.com/rwth-acis/yjs/">yjs</a>
-and WebRTC Connector. </p>
-
-<textarea style="width:80%;" rows=40 id="textfield"></textarea>
-
-<p> <a href="https://github.com/rwth-acis/yjs/">yjs</a> is a Framework for Real-Time collaboration on arbitrary data types.
-</p>
-</body>
-</html>

examples/WebRTC/index.js

@@ -1,27 +0,0 @@
-
-
-connector = new Y.WebRTC("testy", {debug: true});
-
-connector.debug = true
-
-y = new Y(connector);
-
-window.onload = function(){
-  var textbox = document.getElementById("textfield");
-  y.observe(function(events){
-    for(var i=0; i<events.length; i++){
-      var event = events[i];
-      if(event.name === "textfield" && event.type !== "delete"){
-        y.val("textfield").bind(textbox);
-        y.val("headline").bind(document.querySelector("h1"))
-      }
-    }
-  });
-  connector.whenSynced(function(){
-    if(y.val("textfield") == null){
-      y.val("headline","headline", "mutable");
-      y.val("textfield","stuff", "mutable")
-    }
-  })
-
-};

examples/XMPP-Polymer/index.html

@@ -1,14 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <meta charset=utf-8 />
-    <title>Y Example</title>
-    <script src="../../../webcomponentsjs/webcomponents.min.js"></script>
-    <link rel="import" href="../../../polymer/polymer.html">
-
-    <link rel="import" href="y-test.html">
-  </head>
-  <body>
-    <y-test></y-test>
-  </body>
-</html>

examples/XMPP-Polymer/y-test.html

@@ -1,55 +0,0 @@
-<link rel="import" href="../../build/browser/y-object.html">
-<link rel="import" href="../../../y-xmpp/build/browser/y-xmpp.html">
-<link rel="import" href="../../../paper-slider/paper-slider.html">
-
-<polymer-element name="y-test" attributes="y connector stuff">
-  <template>
-    <h1 id="text" contentEditable> Check this out !</h1>
-    <y-xmpp id="connector" connector={{connector}} room="testy-xmpp-polymer" syncMode="syncAll" debug="true"></y-xmpp>
-    <y-object connector={{connector}} val={{y}}>
-      <y-property name="slider" val={{slider}}>
-      </y-property>
-      <y-property name="stuff" val={{stuff}}>
-        <y-property id="otherstuff" name="otherstuff" val={{otherstuff}}>
-        </y-property>
-      </y-property>
-    </y-object>
-    <y-object val={{otherstuff}}>
-      <y-property name="nostuff" val={{nostuff}}>
-      </y-property>
-    </y-object>
-    <paper-slider min="0" max="200" immediateValue={{slider}}></paper-slider>
-  </template>
-  <script>
-  Polymer({
-    ready: function(){
-      window.y_stuff_property = this.$.otherstuff;
-      this.y.val("slider",50)
-      var that = this;
-      this.connector.whenSynced(function(){
-        if(that.y.val("text") == null){
-          that.y.val("text","stuff","mutable");
-        }
-        that.y.val("text").bind(that.$.text,that.shadowRoot)
-      })
-
-      // Everything is initialized. Lets test stuff!
-      window.y_test = this;
-      window.y_test.y.val("stuff",{otherstuff:{nostuff:"this is no stuff"}})
-      setTimeout(function(){
-        var res = y_test.y.val("stuff");
-        if(!(y_test.nostuff === "this is no stuff")){
-          console.log("Deep inherit doesn't work!")
-        }
-        window.y_stuff_property.val = {nostuff: "this is also no stuff"};
-        setTimeout(function(){
-          if(!(y_test.nostuff === "this is also no stuff")){
-            console.log("Element val overwrite doesn't work")
-          }
-          console.log("Everything is fine :)");
-        },500)
-      },500);
-    }
-  })
-  </script>
-</polymer-element>

examples/XMPP/index.html

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-        <meta charset=utf-8 />
-        <title>Y Example</title>
-        <script src="../../build/browser/y.js"></script>
-        <script src="../../../y-xmpp/y-xmpp.js"></script>
-        <script src="./index.js"></script>
-</head>
-<body>
-<h1 contentEditable> yjs Tutorial</h1>
-<p> Collaborative Json editing with <a href="https://github.com/rwth-acis/yjs/">yjs</a>
-and XMPP Connector. </p>
-
-<textarea style="width:80%;" rows=40 id="textfield"></textarea>
-
-<p> <a href="https://github.com/rwth-acis/yjs/">yjs</a> is a Framework for Real-Time collaboration on arbitrary data types.
-</p>
-</body>
-</html>

examples/XMPP/index.js

@@ -1,26 +0,0 @@
-
-
-connector = new Y.XMPP().join("testy-xmpp-json3", {syncMode: "syncAll"});
-connector.debug = true
-
-y = new Y(connector);
-
-window.onload = function(){
-  var textbox = document.getElementById("textfield");
-  y.observe(function(events){
-    for(var i=0; i<events.length; i++){
-      var event = events[i];
-      if(event.name === "textfield" && event.type !== "delete"){
-        y.val("textfield").bind(textbox);
-        y.val("headline").bind(document.querySelector("h1"))
-      }
-    }
-  });
-  connector.whenSynced(function(){
-    if(y.val("textfield") == null){
-      y.val("headline","headline", "mutable");
-      y.val("textfield","stuff", "mutable")
-    }
-  })
-
-};

gulpfile.coffee

@@ -1,122 +0,0 @@
-gulp = require('gulp')
-coffee = require('gulp-coffee')
-concat = require('gulp-concat')
-uglify = require 'gulp-uglify'
-sourcemaps = require('gulp-sourcemaps')
-browserify = require('gulp-browserify')
-rename = require 'gulp-rename'
-rimraf = require 'gulp-rimraf'
-gulpif = require 'gulp-if'
-ignore = require 'gulp-ignore'
-git = require 'gulp-git'
-debug = require 'gulp-debug'
-coffeelint = require 'gulp-coffeelint'
-mocha = require 'gulp-mocha'
-run = require 'gulp-run'
-ljs = require 'gulp-ljs'
-plumber = require 'gulp-plumber'
-mochaPhantomJS = require 'gulp-mocha-phantomjs'
-cache = require 'gulp-cached'
-coffeeify = require 'gulp-coffeeify'
-
-gulp.task 'default', ['build_browser']
-
-files =
-  lib : ['./lib/**/*.coffee']
-  browser : ['./lib/y.coffee','./lib/y-object.coffee']
-  #test : ['./test/**/*_test.coffee']
-  test : ['./test/Json_test.coffee', './test/Text_test.coffee']
-  gulp : ['./gulpfile.coffee']
-  examples : ['./examples/**/*.js']
-  other: ['./lib/**/*']
-
-files.all = []
-for name,file_list of files
-  if name isnt 'build'
-    files.all = files.all.concat file_list
-
-gulp.task 'deploy_nodejs', ->
-  gulp.src files.lib
-    .pipe sourcemaps.init()
-    .pipe coffee()
-    .pipe sourcemaps.write './'
-    .pipe gulp.dest 'build/node/'
-    .pipe gulpif '!**/', git.add({args : "-A"})
-
-gulp.task 'deploy', ['mocha', 'build_browser', 'deploy_nodejs', 'lint', 'phantom_test', 'codo']
-
-gulp.task 'build_browser', ->
-  gulp.src files.browser, { read: false }
-    .pipe plumber()
-    .pipe browserify
-      transform: ['coffeeify']
-      extensions: ['.coffee']
-      debug : true
-    .pipe rename
-      extname: ".js"
-    .pipe gulp.dest './build/browser/'
-    .pipe uglify()
-    .pipe gulp.dest '.'
-
-  gulp.src files.test, {read: false}
-    .pipe plumber()
-    .pipe browserify
-      transform: ['coffeeify']
-      extensions: ['.coffee']
-      debug: true
-    .pipe rename
-      extname: ".js"
-    .pipe gulp.dest './build/test/'
-
-gulp.task 'build_node', ->
-  gulp.src files.lib
-    .pipe plumber()
-    .pipe coffee({bare:true})
-    .pipe gulp.dest './build/node'
-
-gulp.task 'build', ['build_node', 'build_browser'], ->
-
-gulp.task 'watch', ['build_browser'], ->
-  gulp.watch files.all, ['build_browser']
-
-gulp.task 'mocha', ->
-  gulp.src files.test, { read: false }
-    .pipe plumber()
-    .pipe mocha {reporter : 'list'}
-
-
-gulp.task 'lint', ->
-  gulp.src files.all
-    .pipe ignore.include '**/*.coffee'
-    .pipe coffeelint {
-      "max_line_length":
-        "level": "ignore"
-      }
-    .pipe coffeelint.reporter()
-
-gulp.task 'phantom_watch', ['phantom_test'], ->
-  gulp.watch files.all, ['phantom_test']
-
-gulp.task 'literate', ->
-  gulp.src files.examples
-    .pipe ljs { code : true }
-    .pipe rename
-      basename : "README"
-      extname : ".md"
-    .pipe gulp.dest 'examples/'
-    .pipe gulpif '!**/', git.add({args : "-A"})
-
-gulp.task 'codo', [], ()->
-  command = './node_modules/codo/bin/codo -o "./doc" --name "yjs" --readme "README.md" --undocumented false --private true --title "yjs API" ./lib - LICENSE.txt '
-  run(command).exec()
-
-gulp.task 'phantom_test', ['build_browser'], ()->
-  gulp.src 'build/test/index.html'
-    .pipe mochaPhantomJS()
-
-gulp.task 'clean', ->
-  gulp.src ['./build/{browser,test,node}/**/*.{js,map}','./doc/'], { read: false }
-    .pipe rimraf()
-
-gulp.task 'default', ['clean','build'], ->
-

lib/ConnectorAdapter.coffee

@@ -1,62 +0,0 @@
-
-ConnectorClass = require "./ConnectorClass"
-#
-# @param {Engine} engine The transformation engine
-# @param {HistoryBuffer} HB
-# @param {Array<Function>} execution_listener You must ensure that whenever an operation is executed, every function in this Array is called.
-#
-adaptConnector = (connector, engine, HB, execution_listener)->
-
-  for name, f of ConnectorClass
-    connector[name] = f
-
-  connector.setIsBoundToY()
-
-  send_ = (o)->
-    if (o.uid.creator is HB.getUserId()) and
-        (typeof o.uid.op_number isnt "string") and # TODO: i don't think that we need this anymore..
-        (o.uid.doSync is "true" or o.uid.doSync is true) and # TODO: ensure, that only true is valid
-        (HB.getUserId() isnt "_temp")
-      connector.broadcast o
-
-  if connector.invokeSync?
-    HB.setInvokeSyncHandler connector.invokeSync
-
-  execution_listener.push send_
-  # For the XMPPConnector: lets send it as an array
-  # therefore, we have to restructure it later
-  encode_state_vector = (v)->
-    for name,value of v
-      user: name
-      state: value
-  parse_state_vector = (v)->
-    state_vector = {}
-    for s in v
-      state_vector[s.user] = s.state
-    state_vector
-
-  getStateVector = ()->
-    encode_state_vector HB.getOperationCounter()
-
-  getHB = (v)->
-    state_vector = parse_state_vector v
-    hb = HB._encode state_vector
-    json =
-      hb: hb
-      state_vector: encode_state_vector HB.getOperationCounter()
-    json
-
-  applyHB = (hb, fromHB)->
-    engine.applyOp hb, fromHB
-
-  connector.getStateVector = getStateVector
-  connector.getHB = getHB
-  connector.applyHB = applyHB
-
-  connector.receive_handlers ?= []
-  connector.receive_handlers.push (sender, op)->
-    if op.uid.creator isnt HB.getUserId()
-      engine.applyOp op
-
-
-module.exports = adaptConnector

lib/ConnectorClass.coffee

@@ -1,316 +0,0 @@
-
-module.exports =
-  #
-  # @params new Connector(options)
-  #   @param options.syncMethod {String}  is either "syncAll" or "master-slave".
-  #   @param options.role {String} The role of this client
-  #            (slave or master (only used when syncMethod is master-slave))
-  #   @param options.perform_send_again {Boolean} Whetehr to whether to resend the HB after some time period. This reduces sync errors, but has some overhead (optional)
-  #
-  init: (options)->
-    req = (name, choices)=>
-      if options[name]?
-        if (not choices?) or choices.some((c)->c is options[name])
-          @[name] = options[name]
-        else
-          throw new Error "You can set the '"+name+"' option to one of the following choices: "+JSON.encode(choices)
-      else
-        throw new Error "You must specify "+name+", when initializing the Connector!"
-
-    req "syncMethod", ["syncAll", "master-slave"]
-    req "role", ["master", "slave"]
-    req "user_id"
-    @on_user_id_set?(@user_id)
-
-    # whether to resend the HB after some time period. This reduces sync errors.
-    # But this is not necessary in the test-connector
-    if options.perform_send_again?
-      @perform_send_again = options.perform_send_again
-    else
-      @perform_send_again = true
-
-    # A Master should sync with everyone! TODO: really? - for now its safer this way!
-    if @role is "master"
-      @syncMethod = "syncAll"
-
-    # is set to true when this is synced with all other connections
-    @is_synced = false
-    # Peerjs Connections: key: conn-id, value: object
-    @connections = {}
-    # List of functions that shall process incoming data
-    @receive_handlers ?= []
-
-    # whether this instance is bound to any y instance
-    @connections = {}
-    @current_sync_target = null
-    @sent_hb_to_all_users = false
-    @is_initialized = true
-
-  isRoleMaster: ->
-    @role is "master"
-
-  isRoleSlave: ->
-    @role is "slave"
-
-  findNewSyncTarget: ()->
-    @current_sync_target = null
-    if @syncMethod is "syncAll"
-      for user, c of @connections
-        if not c.is_synced
-          @performSync user
-          break
-    if not @current_sync_target?
-      @setStateSynced()
-    null
-
-  userLeft: (user)->
-    delete @connections[user]
-    @findNewSyncTarget()
-
-  userJoined: (user, role)->
-    if not role?
-      throw new Error "Internal: You must specify the role of the joined user! E.g. userJoined('uid:3939','slave')"
-    # a user joined the room
-    @connections[user] ?= {}
-    @connections[user].is_synced = false
-
-    if (not @is_synced) or @syncMethod is "syncAll"
-      if @syncMethod is "syncAll"
-        @performSync user
-      else if role is "master"
-        # TODO: What if there are two masters? Prevent sending everything two times!
-        @performSyncWithMaster user
-
-
-  #
-  # Execute a function _when_ we are connected. If not connected, wait until connected.
-  # @param f {Function} Will be executed on the PeerJs-Connector context.
-  #
-  whenSynced: (args)->
-    if args.constructore is Function
-      args = [args]
-    if @is_synced
-      args[0].apply this, args[1..]
-    else
-      @compute_when_synced ?= []
-      @compute_when_synced.push args
-
-  #
-  # Execute an function when a message is received.
-  # @param f {Function} Will be executed on the PeerJs-Connector context. f will be called with (sender_id, broadcast {true|false}, message).
-  #
-  onReceive: (f)->
-    @receive_handlers.push f
-
-  ###
-  # Broadcast a message to all connected peers.
-  # @param message {Object} The message to broadcast.
-  #
-  broadcast: (message)->
-    throw new Error "You must implement broadcast!"
-
-  #
-  # Send a message to a peer, or set of peers
-  #
-  send: (peer_s, message)->
-    throw new Error "You must implement send!"
-  ###
-
-  #
-  # perform a sync with a specific user.
-  #
-  performSync: (user)->
-    if not @current_sync_target?
-      @current_sync_target = user
-      @send user,
-        sync_step: "getHB"
-        send_again: "true"
-        data: [] # @getStateVector()
-      if not @sent_hb_to_all_users
-        @sent_hb_to_all_users = true
-
-        hb = @getHB([]).hb
-        _hb = []
-        for o in hb
-          _hb.push o
-          if _hb.length > 30
-            @broadcast
-              sync_step: "applyHB_"
-              data: _hb
-            _hb = []
-        @broadcast
-          sync_step: "applyHB"
-          data: _hb
-
-
-
-  #
-  # When a master node joined the room, perform this sync with him. It will ask the master for the HB,
-  # and will broadcast his own HB
-  #
-  performSyncWithMaster: (user)->
-    @current_sync_target = user
-    @send user,
-      sync_step: "getHB"
-      send_again: "true"
-      data: []
-    hb = @getHB([]).hb
-    _hb = []
-    for o in hb
-      _hb.push o
-      if _hb.length > 30
-        @broadcast
-          sync_step: "applyHB_"
-          data: _hb
-        _hb = []
-    @broadcast
-      sync_step: "applyHB"
-      data: _hb
-
-  #
-  # You are sure that all clients are synced, call this function.
-  #
-  setStateSynced: ()->
-    if not @is_synced
-      @is_synced = true
-      if @compute_when_synced?
-        for f in @compute_when_synced
-          f()
-        delete @compute_when_synced
-      null
-
-  #
-  # You received a raw message, and you know that it is intended for to Yjs. Then call this function.
-  #
-  receiveMessage: (sender, res)->
-    if not res.sync_step?
-      for f in @receive_handlers
-        f sender, res
-    else
-      if sender is @user_id
-        return
-      if res.sync_step is "getHB"
-        data = @getHB(res.data)
-        hb = data.hb
-        _hb = []
-        # always broadcast, when not synced.
-        # This reduces errors, when the clients goes offline prematurely.
-        # When this client only syncs to one other clients, but looses connectors,
-        # before syncing to the other clients, the online clients have different states.
-        # Since we do not want to perform regular syncs, this is a good alternative
-        if @is_synced
-          sendApplyHB = (m)=>
-            @send sender, m
-        else
-          sendApplyHB = (m)=>
-            @broadcast m
-
-        for o in hb
-          _hb.push o
-          if _hb.length > 30
-            sendApplyHB
-              sync_step: "applyHB_"
-              data: _hb
-            _hb = []
-
-        sendApplyHB
-          sync_step : "applyHB"
-          data: _hb
-
-        if res.send_again? and @perform_send_again
-          send_again = do (sv = data.state_vector)=>
-            ()=>
-              hb = @getHB(sv).hb
-              @send sender,
-                sync_step: "applyHB",
-                data: hb
-                sent_again: "true"
-          setTimeout send_again, 3000
-      else if res.sync_step is "applyHB"
-        @applyHB(res.data, sender is @current_sync_target)
-
-        if (@syncMethod is "syncAll" or res.sent_again?) and (not @is_synced) and ((@current_sync_target is sender) or (not @current_sync_target?))
-          @connections[sender].is_synced = true
-          @findNewSyncTarget()
-
-      else if res.sync_step is "applyHB_"
-        @applyHB(res.data, sender is @current_sync_target)
-
-
-  # Currently, the HB encodes operations as JSON. For the moment I want to keep it
-  # that way. Maybe we support encoding in the HB as XML in the future, but for now I don't want
-  # too much overhead. Y is very likely to get changed a lot in the future
-  #
-  # Because we don't want to encode JSON as string (with character escaping, wich makes it pretty much unreadable)
-  # we encode the JSON as XML.
-  #
-  # When the HB support encoding as XML, the format should look pretty much like this.
-
-  # does not support primitive values as array elements
-  # expects an ltx (less than xml) object
-  parseMessageFromXml: (m)->
-    parse_array = (node)->
-      for n in node.children
-        if n.getAttribute("isArray") is "true"
-          parse_array n
-        else
-          parse_object n
-
-    parse_object = (node)->
-      json = {}
-      for name, value  of node.attrs
-        int = parseInt(value)
-        if isNaN(int) or (""+int) isnt value
-          json[name] = value
-        else
-          json[name] = int
-      for n in node.children
-        name = n.name
-        if n.getAttribute("isArray") is "true"
-          json[name] = parse_array n
-        else
-          json[name] = parse_object n
-      json
-    parse_object m
-
-  # encode message in xml
-  # we use string because Strophe only accepts an "xml-string"..
-  # So {a:4,b:{c:5}} will look like
-  # <y a="4">
-  #   <b c="5"></b>
-  # </y>
-  # m - ltx element
-  # json - guess it ;)
-  #
-  encodeMessageToXml: (m, json)->
-    # attributes is optional
-    encode_object = (m, json)->
-      for name,value of json
-        if not value?
-          # nop
-        else if value.constructor is Object
-          encode_object m.c(name), value
-        else if value.constructor is Array
-          encode_array m.c(name), value
-        else
-          m.setAttribute(name,value)
-      m
-    encode_array = (m, array)->
-      m.setAttribute("isArray","true")
-      for e in array
-        if e.constructor is Object
-          encode_object m.c("array-element"), e
-        else
-          encode_array m.c("array-element"), e
-      m
-    if json.constructor is Object
-      encode_object m.c("y",{xmlns:"http://y.ninja/connector-stanza"}), json
-    else if json.constructor is Array
-      encode_array m.c("y",{xmlns:"http://y.ninja/connector-stanza"}), json
-    else
-      throw new Error "I can't encode this json!"
-
-  setIsBoundToY: ()->
-    @on_bound_to_y?()
-    delete @when_bound_to_y
-    @is_bound_to_y = true

lib/Engine.coffee

@@ -1,114 +0,0 @@
-
-window?.unprocessed_counter = 0 # del this
-window?.unprocessed_exec_counter = 0 # TODO
-window?.unprocessed_types = []
-
-#
-# @nodoc
-# The Engine handles how and in which order to execute operations and add operations to the HistoryBuffer.
-#
-class Engine
-
-  #
-  # @param {HistoryBuffer} HB
-  # @param {Object} types list of available types
-  #
-  constructor: (@HB, @types)->
-    @unprocessed_ops = []
-
-  #
-  # Parses an operatio from the json format. It uses the specified parser in your OperationType module.
-  #
-  parseOperation: (json)->
-    type = @types[json.type]
-    if type?.parse?
-      type.parse json
-    else
-      throw new Error "You forgot to specify a parser for type #{json.type}. The message is #{JSON.stringify json}."
-
-
-  #
-  # Apply a set of operations. E.g. the operations you received from another users HB._encode().
-  # @note You must not use this method when you already have ops in your HB!
-  ###
-  applyOpsBundle: (ops_json)->
-    ops = []
-    for o in ops_json
-      ops.push @parseOperation o
-    for o in ops
-      if not o.execute()
-        @unprocessed_ops.push o
-    @tryUnprocessed()
-  ###
-
-  #
-  # Same as applyOps but operations that are already in the HB are not applied.
-  # @see Engine.applyOps
-  #
-  applyOpsCheckDouble: (ops_json)->
-    for o in ops_json
-      if not @HB.getOperation(o.uid)?
-        @applyOp o
-
-  #
-  # Apply a set of operations. (Helper for using applyOp on Arrays)
-  # @see Engine.applyOp
-  applyOps: (ops_json)->
-    @applyOp ops_json
-
-  #
-  # Apply an operation that you received from another peer.
-  # TODO: make this more efficient!!
-  # - operations may only executed in order by creator, order them in object of arrays (key by creator)
-  # - you can probably make something like dependencies (creator1 waits for creator2)
-  applyOp: (op_json_array, fromHB = false)->
-    if op_json_array.constructor isnt Array
-      op_json_array = [op_json_array]
-    for op_json in op_json_array
-      if fromHB
-        op_json.fromHB = "true" # execute immediately, if 
-      # $parse_and_execute will return false if $o_json was parsed and executed, otherwise the parsed operadion
-      o = @parseOperation op_json
-      if op_json.fromHB?
-        o.fromHB = op_json.fromHB
-      # @HB.addOperation o
-      if @HB.getOperation(o)?
-        # nop
-      else if ((not @HB.isExpectedOperation(o)) and (not o.fromHB?)) or (not o.execute())
-        @unprocessed_ops.push o
-        window?.unprocessed_types.push o.type # TODO: delete this
-    @tryUnprocessed()
-
-  #
-  # Call this method when you applied a new operation.
-  # It checks if operations that were previously not executable are now executable.
-  #
-  tryUnprocessed: ()->
-    while true
-      old_length = @unprocessed_ops.length
-      unprocessed = []
-      for op in @unprocessed_ops
-        if @HB.getOperation(op)?
-          # nop
-        else if (not @HB.isExpectedOperation(op) and (not op.fromHB?)) or (not op.execute())
-          unprocessed.push op
-      @unprocessed_ops = unprocessed
-      if @unprocessed_ops.length is old_length
-        break
-    if @unprocessed_ops.length isnt 0
-      @HB.invokeSync()
-
-
-module.exports = Engine
-
-
-
-
-
-
-
-
-
-
-
-

lib/HistoryBuffer.coffee

@@ -1,223 +0,0 @@
-
-#
-# @nodoc
-# An object that holds all applied operations.
-#
-# @note The HistoryBuffer is commonly abbreviated to HB.
-#
-class HistoryBuffer
-
-  #
-  # Creates an empty HB.
-  # @param {Object} user_id Creator of the HB.
-  #
-  constructor: (@user_id)->
-    @operation_counter = {}
-    @buffer = {}
-    @change_listeners = []
-    @garbage = [] # Will be cleaned on next call of garbageCollector
-    @trash = [] # Is deleted. Wait until it is not used anymore.
-    @performGarbageCollection = true
-    @garbageCollectTimeout = 30000
-    @reserved_identifier_counter = 0
-    setTimeout @emptyGarbage, @garbageCollectTimeout
-
-  resetUserId: (id)->
-    own = @buffer[@user_id]
-    if own?
-      for o_name,o of own
-        if o.uid.creator?
-          o.uid.creator = id
-        if o.uid.alt?
-          o.uid.alt.creator = id
-      if @buffer[id]?
-        throw new Error "You are re-assigning an old user id - this is not (yet) possible!"
-      @buffer[id] = own
-      delete @buffer[@user_id]
-    if @operation_counter[@user_id]?
-      @operation_counter[id] = @operation_counter[@user_id]
-      delete @operation_counter[@user_id]
-    @user_id = id
-
-  emptyGarbage: ()=>
-    for o in @garbage
-      #if @getOperationCounter(o.uid.creator) > o.uid.op_number
-      o.cleanup?()
-
-    @garbage = @trash
-    @trash = []
-    if @garbageCollectTimeout isnt -1
-      @garbageCollectTimeoutId = setTimeout @emptyGarbage, @garbageCollectTimeout
-    undefined
-
-  #
-  # Get the user id with wich the History Buffer was initialized.
-  #
-  getUserId: ()->
-    @user_id
-
-  addToGarbageCollector: ()->
-    if @performGarbageCollection
-      for o in arguments
-        if o?
-          @garbage.push o
-
-  stopGarbageCollection: ()->
-    @performGarbageCollection = false
-    @setManualGarbageCollect()
-    @garbage = []
-    @trash = []
-
-  setManualGarbageCollect: ()->
-    @garbageCollectTimeout = -1
-    clearTimeout @garbageCollectTimeoutId
-    @garbageCollectTimeoutId = undefined
-
-  setGarbageCollectTimeout: (@garbageCollectTimeout)->
-
-  #
-  # I propose to use it in your Framework, to create something like a root element.
-  # An operation with this identifier is not propagated to other clients.
-  # This is why everybode must create the same operation with this uid.
-  #
-  getReservedUniqueIdentifier: ()->
-    {
-      creator : '_'
-      op_number : "_#{@reserved_identifier_counter++}"
-      doSync: false
-    }
-
-  #
-  # Get the operation counter that describes the current state of the document.
-  #
-  getOperationCounter: (user_id)->
-    if not user_id?
-      res = {}
-      for user,ctn of @operation_counter
-        res[user] = ctn
-      res
-    else
-      @operation_counter[user_id]
-
-  isExpectedOperation: (o)->
-    @operation_counter[o.uid.creator] ?= 0
-    o.uid.op_number <= @operation_counter[o.uid.creator]
-    true #TODO: !! this could break stuff. But I dunno why
-
-  #
-  # Encode this operation in such a way that it can be parsed by remote peers.
-  # TODO: Make this more efficient!
-  _encode: (state_vector={})->
-    json = []
-    unknown = (user, o_number)->
-      if (not user?) or (not o_number?)
-        throw new Error "dah!"
-      not state_vector[user]? or state_vector[user] <= o_number
-
-    for u_name,user of @buffer
-      # TODO next, if @state_vector[user] <= state_vector[user]
-      for o_number,o of user
-        if (not o.uid.noOperation?) and o.uid.doSync and unknown(u_name, o_number)
-          # its necessary to send it, and not known in state_vector
-          o_json = o._encode()
-          if o.next_cl? # applies for all ops but the most right delimiter!
-            # search for the next _known_ operation. (When state_vector is {} then this is the Delimiter)
-            o_next = o.next_cl
-            while o_next.next_cl? and unknown(o_next.uid.creator, o_next.uid.op_number)
-              o_next = o_next.next_cl
-            o_json.next = o_next.getUid()
-          else if o.prev_cl? # most right delimiter only!
-            # same as the above with prev.
-            o_prev = o.prev_cl
-            while o_prev.prev_cl? and unknown(o_prev.uid.creator, o_prev.uid.op_number)
-              o_prev = o_prev.prev_cl
-            o_json.prev = o_prev.getUid()
-          json.push o_json
-
-    json
-
-  #
-  # Get the number of operations that were created by a user.
-  # Accordingly you will get the next operation number that is expected from that user.
-  # This will increment the operation counter.
-  #
-  getNextOperationIdentifier: (user_id)->
-    if not user_id?
-      user_id = @user_id
-    if not @operation_counter[user_id]?
-      @operation_counter[user_id] = 0
-    uid =
-      'creator' : user_id
-      'op_number' : @operation_counter[user_id]
-      'doSync' : true
-    @operation_counter[user_id]++
-    uid
-
-  #
-  # Retrieve an operation from a unique id.
-  #
-  # when uid has a "sub" property, the value of it will be applied
-  # on the operations retrieveSub method (which must! be defined)
-  #
-  getOperation: (uid)->
-    if uid.uid?
-      uid = uid.uid
-    o = @buffer[uid.creator]?[uid.op_number]
-    if uid.sub? and o?
-      o.retrieveSub uid.sub
-    else
-      o
-
-  #
-  # Add an operation to the HB. Note that this will not link it against
-  # other operations (it wont executed)
-  #
-  addOperation: (o)->
-    if not @buffer[o.uid.creator]?
-      @buffer[o.uid.creator] = {}
-    if @buffer[o.uid.creator][o.uid.op_number]?
-      throw new Error "You must not overwrite operations!"
-    if (o.uid.op_number.constructor isnt String) and (not @isExpectedOperation(o)) and (not o.fromHB?) # you already do this in the engine, so delete it here!
-      throw new Error "this operation was not expected!"
-    @addToCounter(o)
-    @buffer[o.uid.creator][o.uid.op_number] = o
-    o
-
-  removeOperation: (o)->
-    delete @buffer[o.uid.creator]?[o.uid.op_number]
-
-  # When the HB determines inconsistencies, then the invokeSync
-  # handler wil be called, which should somehow invoke the sync with another collaborator.
-  # The parameter of the sync handler is the user_id with wich an inconsistency was determined
-  setInvokeSyncHandler: (f)->
-    @invokeSync = f
-
-  # empty per default # TODO: do i need this?
-  invokeSync: ()->
-
-  # after you received the HB of another user (in the sync process),
-  # you renew your own state_vector to the state_vector of the other user
-  renewStateVector: (state_vector)->
-    for user,state of state_vector
-      if ((not @operation_counter[user]?) or (@operation_counter[user] < state_vector[user])) and state_vector[user]?
-        @operation_counter[user] = state_vector[user]
-
-  #
-  # Increment the operation_counter that defines the current state of the Engine.
-  #
-  addToCounter: (o)->
-    if not @operation_counter[o.uid.creator]?
-      @operation_counter[o.uid.creator] = 0
-    if typeof o.uid.op_number is 'number' and o.uid.creator isnt @getUserId()
-      # TODO: check if operations are send in order
-      if o.uid.op_number is @operation_counter[o.uid.creator]
-        @operation_counter[o.uid.creator]++
-      else
-        @invokeSync o.uid.creator
-
-    #if @operation_counter[o.uid.creator] isnt (o.uid.op_number + 1)
-      #console.log (@operation_counter[o.uid.creator] - (o.uid.op_number + 1))
-      #console.log o
-      #throw new Error "You don't receive operations in the proper order. Try counting like this 0,1,2,3,4,.. ;)"
-
-module.exports = HistoryBuffer

lib/Types/BasicTypes.coffee

@@ -1,561 +0,0 @@
-module.exports = (HB)->
-  # @see Engine.parse
-  types = {}
-  execution_listener = []
-
-  #
-  # @private
-  # @abstract
-  # @nodoc
-  # A generic interface to operations.
-  #
-  # An operation has the following methods:
-  # * _encode: encodes an operation (needed only if instance of this operation is sent).
-  # * execute: execute the effects of this operations. Good examples are Insert-type and AddName-type
-  # * val: in the case that the operation holds a value
-  #
-  # Furthermore an encodable operation has a parser. We extend the parser object in order to parse encoded operations.
-  #
-  class types.Operation
-
-    #
-    # @param {Object} uid A unique identifier.
-    # If uid is undefined, a new uid will be created before at the end of the execution sequence
-    #
-    constructor: (uid)->
-      @is_deleted = false
-      @garbage_collected = false
-      @event_listeners = [] # TODO: rename to observers or sth like that
-      if uid?
-        @uid = uid
-
-    type: "Operation"
-
-    retrieveSub: ()->
-      throw new Error "sub properties are not enable on this operation type!"
-
-    #
-    # Add an event listener. It depends on the operation which events are supported.
-    # @param {Function} f f is executed in case the event fires.
-    #
-    observe: (f)->
-      @event_listeners.push f
-
-    #
-    # Deletes function from the observer list
-    # @see Operation.observe
-    #
-    # @overload unobserve(event, f)
-    #   @param f     {Function} The function that you want to delete 
-    unobserve: (f)->
-      @event_listeners = @event_listeners.filter (g)->
-        f isnt g
-
-    #
-    # Deletes all subscribed event listeners.
-    # This should be called, e.g. after this has been replaced.
-    # (Then only one replace event should fire. )
-    # This is also called in the cleanup method.
-    deleteAllObservers: ()->
-      @event_listeners = []
-
-    delete: ()->
-      (new types.Delete undefined, @).execute()
-      null
-
-    #
-    # Fire an event.
-    # TODO: Do something with timeouts. You don't want this to fire for every operation (e.g. insert).
-    # TODO: do you need callEvent+forwardEvent? Only one suffices probably
-    callEvent: ()->
-      @forwardEvent @, arguments...
-
-    #
-    # Fire an event and specify in which context the listener is called (set 'this').
-    # TODO: do you need this ?
-    forwardEvent: (op, args...)->
-      for f in @event_listeners
-        f.call op, args...
-
-    isDeleted: ()->
-      @is_deleted
-
-    applyDelete: (garbagecollect = true)->
-      if not @garbage_collected
-        #console.log "applyDelete: #{@type}"
-        @is_deleted = true
-        if garbagecollect
-          @garbage_collected = true
-          HB.addToGarbageCollector @
-
-    cleanup: ()->
-      #console.log "cleanup: #{@type}"
-      HB.removeOperation @
-      @deleteAllObservers()
-
-    #
-    # Set the parent of this operation.
-    #
-    setParent: (@parent)->
-
-    #
-    # Get the parent of this operation.
-    #
-    getParent: ()->
-      @parent
-
-    #
-    # Computes a unique identifier (uid) that identifies this operation.
-    #
-    getUid: ()->
-      if not @uid.noOperation?
-        @uid
-      else
-        if @uid.alt? # could be (safely) undefined
-          map_uid = @uid.alt.cloneUid()
-          map_uid.sub = @uid.sub
-          map_uid.doSync = false
-          map_uid
-        else
-          undefined
-
-    cloneUid: ()->
-      uid = {}
-      for n,v of @getUid()
-        uid[n] = v
-      uid
-
-    dontSync: ()->
-      @uid.doSync = false
-
-    #
-    # @private
-    # If not already done, set the uid
-    # Add this to the HB
-    # Notify the all the listeners.
-    #
-    execute: ()->
-      @is_executed = true
-      if not @uid?
-        # When this operation was created without a uid, then set it here.
-        # There is only one other place, where this can be done - before an Insertion
-        # is executed (because we need the creator_id)
-        @uid = HB.getNextOperationIdentifier()
-      if not @uid.noOperation?
-        HB.addOperation @
-        for l in execution_listener
-          l @_encode()
-      @
-
-    #
-    # @private
-    # Operations may depend on other operations (linked lists, etc.).
-    # The saveOperation and validateSavedOperations methods provide
-    # an easy way to refer to these operations via an uid or object reference.
-    #
-    # For example: We can create a new Delete operation that deletes the operation $o like this
-    #     - var d = new Delete(uid, $o);   or
-    #     - var d = new Delete(uid, $o.getUid());
-    # Either way we want to access $o via d.deletes. In the second case validateSavedOperations must be called first.
-    #
-    # @overload saveOperation(name, op_uid)
-    #   @param {String} name The name of the operation. After validating (with validateSavedOperations) the instantiated operation will be accessible via this[name].
-    #   @param {Object} op_uid A uid that refers to an operation
-    # @overload saveOperation(name, op)
-    #   @param {String} name The name of the operation. After calling this function op is accessible via this[name].
-    #   @param {Operation} op An Operation object
-    #
-    saveOperation: (name, op)->
-
-      #
-      # Every instance of $Operation must have an $execute function.
-      # We use duck-typing to check if op is instantiated since there
-      # could exist multiple classes of $Operation
-      #
-      if op?.execute?
-        # is instantiated
-        @[name] = op
-      else if op?
-        # not initialized. Do it when calling $validateSavedOperations()
-        @unchecked ?= {}
-        @unchecked[name] = op
-
-    #
-    # @private
-    # After calling this function all not instantiated operations will be accessible.
-    # @see Operation.saveOperation
-    #
-    # @return [Boolean] Whether it was possible to instantiate all operations.
-    #
-    validateSavedOperations: ()->
-      uninstantiated = {}
-      success = @
-      for name, op_uid of @unchecked
-        op = HB.getOperation op_uid
-        if op
-          @[name] = op
-        else
-          uninstantiated[name] = op_uid
-          success = false
-      delete @unchecked
-      if not success
-        @unchecked = uninstantiated
-      success
-
-  #
-  # @nodoc
-  # A simple Delete-type operation that deletes an operation.
-  #
-  class types.Delete extends types.Operation
-
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Object} deletes UID or reference of the operation that this to be deleted.
-    #
-    constructor: (uid, deletes)->
-      @saveOperation 'deletes', deletes
-      super uid
-
-    type: "Delete"
-
-    #
-    # @private
-    # Convert all relevant information of this operation to the json-format.
-    # This result can be sent to other clients.
-    #
-    _encode: ()->
-      {
-        'type': "Delete"
-        'uid': @getUid()
-        'deletes': @deletes.getUid()
-      }
-
-    #
-    # @private
-    # Apply the deletion.
-    #
-    execute: ()->
-      if @validateSavedOperations()
-        res = super
-        if res
-          @deletes.applyDelete @
-        res
-      else
-        false
-
-  #
-  # Define how to parse Delete operations.
-  #
-  types.Delete.parse = (o)->
-    {
-      'uid' : uid
-      'deletes': deletes_uid
-    } = o
-    new this(uid, deletes_uid)
-
-  #
-  # @nodoc
-  # A simple insert-type operation.
-  #
-  # An insert operation is always positioned between two other insert operations.
-  # Internally this is realized as associative lists, whereby each insert operation has a predecessor and a successor.
-  # For the sake of efficiency we maintain two lists:
-  #   - The short-list (abbrev. sl) maintains only the operations that are not deleted
-  #   - The complete-list (abbrev. cl) maintains all operations
-  #
-  class types.Insert extends types.Operation
-
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Operation} prev_cl The predecessor of this operation in the complete-list (cl)
-    # @param {Operation} next_cl The successor of this operation in the complete-list (cl)
-    #
-    constructor: (uid, prev_cl, next_cl, origin, parent)->
-      @saveOperation 'parent', parent
-      @saveOperation 'prev_cl', prev_cl
-      @saveOperation 'next_cl', next_cl
-      if origin?
-        @saveOperation 'origin', origin
-      else
-        @saveOperation 'origin', prev_cl
-      super uid
-
-    type: "Insert"
-
-    #
-    # set content to null and other stuff
-    # @private
-    #
-    applyDelete: (o)->
-      @deleted_by ?= []
-      callLater = false
-      if @parent? and not @isDeleted() and o? # o? : if not o?, then the delimiter deleted this Insertion. Furthermore, it would be wrong to call it. TODO: make this more expressive and save
-        # call iff wasn't deleted earlyer
-        callLater = true
-      if o?
-        @deleted_by.push o
-      garbagecollect = false
-      if @next_cl.isDeleted()
-        garbagecollect = true
-      super garbagecollect
-      if callLater
-        @callOperationSpecificDeleteEvents(o)
-      if @prev_cl?.isDeleted()
-        # garbage collect prev_cl
-        @prev_cl.applyDelete()
-
-    cleanup: ()->
-      if @next_cl.isDeleted()
-        # delete all ops that delete this insertion
-        for d in @deleted_by
-          d.cleanup()
-
-        # throw new Error "right is not deleted. inconsistency!, wrararar"
-        # change origin references to the right
-        o = @next_cl
-        while o.type isnt "Delimiter"
-          if o.origin is @
-            o.origin = @prev_cl
-          o = o.next_cl
-        # reconnect left/right
-        @prev_cl.next_cl = @next_cl
-        @next_cl.prev_cl = @prev_cl
-        super
-      # else
-      #   Someone inserted something in the meantime.
-      #   Remember: this can only be garbage collected when next_cl is deleted
-
-    #
-    # @private
-    # The amount of positions that $this operation was moved to the right.
-    #
-    getDistanceToOrigin: ()->
-      d = 0
-      o = @prev_cl
-      while true
-        if @origin is o
-          break
-        d++
-        o = o.prev_cl
-      d
-
-    #
-    # @private
-    # Include this operation in the associative lists.
-    execute: ()->
-      if not @validateSavedOperations()
-        return false
-      else
-        if @parent?
-          if not @prev_cl?
-            @prev_cl = @parent.beginning
-          if not @origin?
-            @origin = @parent.beginning
-          if not @next_cl?
-            @next_cl = @parent.end
-        if @prev_cl?
-          distance_to_origin = @getDistanceToOrigin() # most cases: 0
-          o = @prev_cl.next_cl
-          i = distance_to_origin # loop counter
-
-          # $this has to find a unique position between origin and the next known character
-          # case 1: $origin equals $o.origin: the $creator parameter decides if left or right
-          #         let $OL= [o1,o2,o3,o4], whereby $this is to be inserted between o1 and o4
-          #         o2,o3 and o4 origin is 1 (the position of o2)
-          #         there is the case that $this.creator < o2.creator, but o3.creator < $this.creator
-          #         then o2 knows o3. Since on another client $OL could be [o1,o3,o4] the problem is complex
-          #         therefore $this would be always to the right of o3
-          # case 2: $origin < $o.origin
-          #         if current $this insert_position > $o origin: $this ins
-          #         else $insert_position will not change
-          #         (maybe we encounter case 1 later, then this will be to the right of $o)
-          # case 3: $origin > $o.origin
-          #         $this insert_position is to the left of $o (forever!)
-          while true
-            if o isnt @next_cl
-              # $o happened concurrently
-              if o.getDistanceToOrigin() is i
-                # case 1
-                if o.uid.creator < @uid.creator
-                  @prev_cl = o
-                  distance_to_origin = i + 1
-                else
-                  # nop
-              else if o.getDistanceToOrigin() < i
-                # case 2
-                if i - distance_to_origin <= o.getDistanceToOrigin()
-                  @prev_cl = o
-                  distance_to_origin = i + 1
-                else
-                  #nop
-              else
-                # case 3
-                break
-              i++
-              o = o.next_cl
-            else
-              # $this knows that $o exists,
-              break
-          # now reconnect everything
-          @next_cl = @prev_cl.next_cl
-          @prev_cl.next_cl = @
-          @next_cl.prev_cl = @
-
-        @setParent @prev_cl.getParent() # do Insertions always have a parent?
-        super # notify the execution_listeners
-        @callOperationSpecificInsertEvents()
-        @
-
-    callOperationSpecificInsertEvents: ()->
-      @parent?.callEvent [
-        type: "insert"
-        position: @getPosition()
-        object: @parent
-        changedBy: @uid.creator
-        value: @content
-      ]
-
-    callOperationSpecificDeleteEvents: (o)->
-      @parent.callEvent [
-        type: "delete"
-        position: @getPosition()
-        object: @parent # TODO: You can combine getPosition + getParent in a more efficient manner! (only left Delimiter will hold @parent)
-        length: 1
-        changedBy: o.uid.creator
-      ]
-
-    #
-    # Compute the position of this operation.
-    #
-    getPosition: ()->
-      position = 0
-      prev = @prev_cl
-      while true
-        if prev instanceof types.Delimiter
-          break
-        if not prev.isDeleted()
-          position++
-        prev = prev.prev_cl
-      position
-
-  #
-  # @nodoc
-  # Defines an object that is cannot be changed. You can use this to set an immutable string, or a number.
-  #
-  class types.ImmutableObject extends types.Operation
-
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Object} content
-    #
-    constructor: (uid, @content)->
-      super uid
-
-    type: "ImmutableObject"
-
-    #
-    # @return [String] The content of this operation.
-    #
-    val : ()->
-      @content
-
-    #
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json = {
-        'type': @type
-        'uid' : @getUid()
-        'content' : @content
-      }
-      json
-
-  types.ImmutableObject.parse = (json)->
-    {
-      'uid' : uid
-      'content' : content
-    } = json
-    new this(uid, content)
-
-  #
-  # @nodoc
-  # A delimiter is placed at the end and at the beginning of the associative lists.
-  # This is necessary in order to have a beginning and an end even if the content
-  # of the Engine is empty.
-  #
-  class types.Delimiter extends types.Operation
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Operation} prev_cl The predecessor of this operation in the complete-list (cl)
-    # @param {Operation} next_cl The successor of this operation in the complete-list (cl)
-    #
-    constructor: (prev_cl, next_cl, origin)->
-      @saveOperation 'prev_cl', prev_cl
-      @saveOperation 'next_cl', next_cl
-      @saveOperation 'origin', prev_cl
-      super {noOperation: true}
-
-    type: "Delimiter"
-
-    applyDelete: ()->
-      super()
-      o = @prev_cl
-      while o?
-        o.applyDelete()
-        o = o.prev_cl
-      undefined
-
-    cleanup: ()->
-      super()
-
-    #
-    # @private
-    #
-    execute: ()->
-      if @unchecked?['next_cl']?
-        super
-      else if @unchecked?['prev_cl']
-        if @validateSavedOperations()
-          if @prev_cl.next_cl?
-            throw new Error "Probably duplicated operations"
-          @prev_cl.next_cl = @
-          super
-        else
-          false
-      else if @prev_cl? and not @prev_cl.next_cl?
-        delete @prev_cl.unchecked.next_cl
-        @prev_cl.next_cl = @
-        super
-      else if @prev_cl? or @next_cl? or true # TODO: are you sure? This can happen right?
-        super
-      #else
-      #  throw new Error "Delimiter is unsufficient defined!"
-
-    #
-    # @private
-    #
-    _encode: ()->
-      {
-        'type' : @type
-        'uid' : @getUid()
-        'prev' : @prev_cl?.getUid()
-        'next' : @next_cl?.getUid()
-      }
-
-  types.Delimiter.parse = (json)->
-    {
-    'uid' : uid
-    'prev' : prev
-    'next' : next
-    } = json
-    new this(uid, prev, next)
-
-  # This is what this module exports after initializing it with the HistoryBuffer
-  {
-    'types' : types
-    'execution_listener' : execution_listener
-  }
-
-
-
-

lib/Types/JsonTypes.coffee

@@ -1,148 +0,0 @@
-text_types_uninitialized = require "./TextTypes"
-
-module.exports = (HB)->
-  text_types = text_types_uninitialized HB
-  types = text_types.types
-
-  #
-  # Manages Object-like values.
-  #
-  class types.Object extends types.MapManager
-
-    #
-    # Identifies this class.
-    # Use it to check whether this is a json-type or something else.
-    #
-    # @example
-    #   var x = y.val('unknown')
-    #   if (x.type === "Object") {
-    #     console.log JSON.stringify(x.toJson())
-    #   }
-    #
-    type: "Object"
-
-    applyDelete: ()->
-      super()
-
-    cleanup: ()->
-      super()
-
-
-    #
-    # Transform this to a Json. If your browser supports Object.observe it will be transformed automatically when a change arrives.
-    # Otherwise you will loose all the sharing-abilities (the new object will be a deep clone)!
-    # @return {Json}
-    #
-    # TODO: at the moment you don't consider changing of properties.
-    # E.g.: let x = {a:[]}. Then x.a.push 1 wouldn't change anything
-    #
-    toJson: (transform_to_value = false)->
-      if not @bound_json? or not Object.observe? or true # TODO: currently, you are not watching mutable strings for changes, and, therefore, the @bound_json is not updated. TODO TODO  wuawuawua easy
-        val = @val()
-        json = {}
-        for name, o of val
-          if o instanceof types.Object
-            json[name] = o.toJson(transform_to_value)
-          else if o instanceof types.Array
-            json[name] = o.toJson(transform_to_value)
-          else if transform_to_value and o instanceof types.Operation
-            json[name] = o.val()
-          else
-            json[name] = o
-        @bound_json = json
-        if Object.observe?
-          that = @
-          Object.observe @bound_json, (events)->
-            for event in events
-              if not event.changedBy? and (event.type is "add" or event.type = "update")
-                # this event is not created by Y.
-                that.val(event.name, event.object[event.name])
-          @observe (events)->
-            for event in events
-              if event.created_ isnt HB.getUserId()
-                notifier = Object.getNotifier(that.bound_json)
-                oldVal = that.bound_json[event.name]
-                if oldVal?
-                  notifier.performChange 'update', ()->
-                      that.bound_json[event.name] = that.val(event.name)
-                    , that.bound_json
-                  notifier.notify
-                    object: that.bound_json
-                    type: 'update'
-                    name: event.name
-                    oldValue: oldVal
-                    changedBy: event.changedBy
-                else
-                  notifier.performChange 'add', ()->
-                      that.bound_json[event.name] = that.val(event.name)
-                    , that.bound_json
-                  notifier.notify
-                    object: that.bound_json
-                    type: 'add'
-                    name: event.name
-                    oldValue: oldVal
-                    changedBy:event.changedBy
-      @bound_json
-
-    #
-    # @overload val()
-    #   Get this as a Json object.
-    #   @return [Json]
-    #
-    # @overload val(name)
-    #   Get value of a property.
-    #   @param {String} name Name of the object property.
-    #   @return [Object Type||String|Object] Depending on the value of the property. If mutable it will return a Operation-type object, if immutable it will return String/Object.
-    #
-    # @overload val(name, content)
-    #   Set a new property.
-    #   @param {String} name Name of the object property.
-    #   @param {Object|String} content Content of the object property.
-    #   @return [Object Type] This object. (supports chaining)
-    #
-    val: (name, content)->
-      if name? and arguments.length > 1
-        if content? and content.constructor?
-          type = types[content.constructor.name]
-          if type? and type.create?
-            args = []
-            for i in [1...arguments.length]
-              args.push arguments[i]
-            o = type.create.apply null, args
-            super name, o
-          else
-            throw new Error "The #{content.constructor.name}-type is not (yet) supported in Y."
-        else
-          super name, content
-      else # is this even necessary ? I have to define every type anyway.. (see Number type below)
-        super name
-
-    #
-    # @private
-    #
-    _encode: ()->
-      {
-        'type' : @type
-        'uid' : @getUid()
-      }
-
-  types.Object.parse = (json)->
-    {
-      'uid' : uid
-    } = json
-    new this(uid)
-
-  types.Object.create = (content, mutable)->
-    json = new types.Object().execute()
-    for n,o of content
-      json.val n, o, mutable
-    json
-
-
-  types.Number = {}
-  types.Number.create = (content)->
-    content
-
-  text_types
-
-

lib/Types/StructuredTypes.coffee

@@ -1,356 +0,0 @@
-basic_types_uninitialized = require "./BasicTypes"
-
-module.exports = (HB)->
-  basic_types = basic_types_uninitialized HB
-  types = basic_types.types
-
-  #
-  # @nodoc
-  # Manages map like objects. E.g. Json-Type and XML attributes.
-  #
-  class types.MapManager extends types.Operation
-
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    #
-    constructor: (uid)->
-      @map = {}
-      super uid
-
-    type: "MapManager"
-
-    applyDelete: ()->
-      for name,p of @map
-        p.applyDelete()
-      super()
-
-    cleanup: ()->
-      super()
-
-    #
-    # @see JsonTypes.val
-    #
-    val: (name, content)->
-      if arguments.length > 1
-        @retrieveSub(name).replace content
-        @
-      else if name?
-        prop = @map[name]
-        if prop? and not prop.isContentDeleted()
-          prop.val()
-        else
-          undefined
-      else
-        result = {}
-        for name,o of @map
-          if not o.isContentDeleted()
-            result[name] = o.val()
-        result
-
-    delete: (name)->
-      @map[name]?.deleteContent()
-      @
-
-    retrieveSub: (property_name)->
-      if not @map[property_name]?
-        event_properties =
-          name: property_name
-        event_this = @
-        rm_uid =
-          noOperation: true
-          sub: property_name
-          alt: @
-        rm = new types.ReplaceManager event_properties, event_this, rm_uid # this operation shall not be saved in the HB
-        @map[property_name] = rm
-        rm.setParent @, property_name
-        rm.execute()
-      @map[property_name]
-
-  #
-  # @nodoc
-  # Manages a list of Insert-type operations.
-  #
-  class types.ListManager extends types.Operation
-
-    #
-    # A ListManager maintains a non-empty list that has a beginning and an end (both Delimiters!)
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Delimiter} beginning Reference or Object.
-    # @param {Delimiter} end Reference or Object.
-    constructor: (uid)->
-      @beginning = new types.Delimiter undefined, undefined
-      @end =       new types.Delimiter @beginning, undefined
-      @beginning.next_cl = @end
-      @beginning.execute()
-      @end.execute()
-      super uid
-
-    type: "ListManager"
-
-    #
-    # @private
-    # @see Operation.execute
-    #
-    execute: ()->
-      if @validateSavedOperations()
-        @beginning.setParent @
-        @end.setParent @
-        super
-      else
-        false
-
-    # Get the element previous to the delemiter at the end
-    getLastOperation: ()->
-      @end.prev_cl
-
-    # similar to the above
-    getFirstOperation: ()->
-      @beginning.next_cl
-
-    # Transforms the the list to an array
-    # Doesn't return left-right delimiter.
-    toArray: ()->
-      o = @beginning.next_cl
-      result = []
-      while o isnt @end
-        result.push o
-        o = o.next_cl
-      result
-
-    #
-    # Retrieves the x-th not deleted element.
-    # e.g. "abc" : the 1th character is "a"
-    # the 0th character is the left Delimiter
-    #
-    getOperationByPosition: (position)->
-      o = @beginning
-      while true
-        # find the i-th op
-        if o instanceof types.Delimiter and o.prev_cl?
-          # the user or you gave a position parameter that is to big
-          # for the current array. Therefore we reach a Delimiter.
-          # Then, we'll just return the last character.
-          o = o.prev_cl
-          while o.isDeleted() or not (o instanceof types.Delimiter)
-            o = o.prev_cl
-          break
-        if position <= 0 and not o.isDeleted()
-          break
-
-        o = o.next_cl
-        if not o.isDeleted()
-          position -= 1
-      o
-
-  #
-  # @nodoc
-  # Adds support for replace. The ReplaceManager manages Replaceable operations.
-  # Each Replaceable holds a value that is now replaceable.
-  #
-  # The TextType-type has implemented support for replace
-  # @see TextType
-  #
-  class types.ReplaceManager extends types.ListManager
-    #
-    # @param {Object} event_properties Decorates the event that is thrown by the RM
-    # @param {Object} event_this The object on which the event shall be executed
-    # @param {Operation} initial_content Initialize this with a Replaceable that holds the initial_content.
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Delimiter} beginning Reference or Object.
-    # @param {Delimiter} end Reference or Object.
-    constructor: (@event_properties, @event_this, uid, beginning, end)->
-      if not @event_properties['object']?
-        @event_properties['object'] = @event_this
-      super uid, beginning, end
-
-    type: "ReplaceManager"
-
-    applyDelete: ()->
-      o = @beginning
-      while o?
-        o.applyDelete()
-        o = o.next_cl
-      super()
-
-    cleanup: ()->
-      super()
-
-    #
-    # This doesn't throw the same events as the ListManager. Therefore, the
-    # Replaceables also not throw the same events.
-    # So, ReplaceManager and ListManager both implement
-    # these functions that are called when an Insertion is executed (at the end).
-    #
-    #
-    callEventDecorator: (events)->
-      if not @isDeleted()
-        for event in events
-          for name,prop of @event_properties
-            event[name] = prop
-        @event_this.callEvent events
-      undefined
-
-    #
-    # Replace the existing word with a new word.
-    #
-    # @param content {Operation} The new value of this ReplaceManager.
-    # @param replaceable_uid {UID} Optional: Unique id of the Replaceable that is created
-    #
-    replace: (content, replaceable_uid)->
-      o = @getLastOperation()
-      relp = (new types.Replaceable content, @, replaceable_uid, o, o.next_cl).execute()
-      # TODO: delete repl (for debugging)
-      undefined
-
-    isContentDeleted: ()->
-      @getLastOperation().isDeleted()
-
-    deleteContent: ()->
-      (new types.Delete undefined, @getLastOperation().uid).execute()
-      undefined
-
-    #
-    # Get the value of this
-    # @return {String}
-    #
-    val: ()->
-      o = @getLastOperation()
-      #if o instanceof types.Delimiter
-        # throw new Error "Replace Manager doesn't contain anything."
-      o.val?() # ? - for the case that (currently) the RM does not contain anything (then o is a Delimiter)
-
-    #
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json =
-        {
-          'type': @type
-          'uid' : @getUid()
-          'beginning' : @beginning.getUid()
-          'end' : @end.getUid()
-        }
-      json
-
-  #
-  # @nodoc
-  # The ReplaceManager manages Replaceables.
-  # @see ReplaceManager
-  #
-  class types.Replaceable extends types.Insert
-
-    #
-    # @param {Operation} content The value that this Replaceable holds.
-    # @param {ReplaceManager} parent Used to replace this Replaceable with another one.
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    #
-    constructor: (content, parent, uid, prev, next, origin, is_deleted)->
-      # see encode to see, why we are doing it this way
-      if content? and content.creator?
-        @saveOperation 'content', content
-      else
-        @content = content
-      @saveOperation 'parent', parent
-      super uid, prev, next, origin # Parent is already saved by Replaceable
-      @is_deleted = is_deleted
-
-    type: "Replaceable"
-
-    #
-    # Return the content that this operation holds.
-    #
-    val: ()->
-      @content
-
-    applyDelete: ()->
-      res = super
-      if @content?
-        if @next_cl.type isnt "Delimiter"
-          @content.deleteAllObservers?()
-        @content.applyDelete?()
-        @content.dontSync?()
-      @content = null
-      res
-
-    cleanup: ()->
-      super
-
-    #
-    # This is called, when the Insert-type was successfully executed.
-    # TODO: consider doing this in a more consistent manner. This could also be
-    # done with execute. But currently, there are no specital Insert-types for ListManager.
-    #
-    callOperationSpecificInsertEvents: ()->
-      if @next_cl.type is "Delimiter" and @prev_cl.type isnt "Delimiter"
-        # this replaces another Replaceable
-        if not @is_deleted # When this is received from the HB, this could already be deleted!
-          old_value = @prev_cl.content
-          @parent.callEventDecorator [
-            type: "update"
-            changedBy: @uid.creator
-            oldValue: old_value
-          ]
-        @prev_cl.applyDelete()
-      else if @next_cl.type isnt "Delimiter"
-        # This won't be recognized by the user, because another
-        # concurrent operation is set as the current value of the RM
-        @applyDelete()
-      else # prev _and_ next are Delimiters. This is the first created Replaceable in the RM
-        @parent.callEventDecorator [
-          type: "add"
-          changedBy: @uid.creator
-        ]
-      undefined
-
-    callOperationSpecificDeleteEvents: (o)->
-      if @next_cl.type is "Delimiter"
-        @parent.callEventDecorator [
-          type: "delete"
-          changedBy: o.uid.creator
-          oldValue: @content
-        ]
-
-    #
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json =
-        {
-          'type': @type
-          'parent' : @parent.getUid()
-          'prev': @prev_cl.getUid()
-          'next': @next_cl.getUid()
-          'origin' : @origin.getUid()
-          'uid' : @getUid()
-          'is_deleted': @is_deleted
-        }
-      if @content instanceof types.Operation
-        json['content'] = @content.getUid()
-      else
-        # This could be a security concern.
-        # Throw error if the users wants to trick us
-        if @content? and @content.creator?
-          throw new Error "You must not set creator here!"
-        json['content'] = @content
-      json
-
-  types.Replaceable.parse = (json)->
-    {
-      'content' : content
-      'parent' : parent
-      'uid' : uid
-      'prev': prev
-      'next': next
-      'origin' : origin
-      'is_deleted': is_deleted
-    } = json
-    new this(content, parent, uid, prev, next, origin, is_deleted)
-
-
-  basic_types
-
-
-
-
-
-

lib/Types/TextTypes.coffee

@@ -1,525 +0,0 @@
-structured_types_uninitialized = require "./StructuredTypes"
-
-module.exports = (HB)->
-  structured_types = structured_types_uninitialized HB
-  types = structured_types.types
-  parser = structured_types.parser
-
-  #
-  # @nodoc
-  # Extends the basic Insert type to an operation that holds a text value
-  #
-  class types.TextInsert extends types.Insert
-    #
-    # @param {String} content The content of this Insert-type Operation. Usually you restrict the length of content to size 1
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    #
-    constructor: (content, uid, prev, next, origin, parent)->
-      if content?.creator
-        @saveOperation 'content', content
-      else
-        @content = content
-      super uid, prev, next, origin, parent
-
-    type: "TextInsert"
-
-    #
-    # Retrieve the effective length of the $content of this operation.
-    #
-    getLength: ()->
-      if @isDeleted()
-        0
-      else
-        @content.length
-
-    applyDelete: ()->
-      super # no braces indeed!
-      if @content instanceof types.Operation
-        @content.applyDelete()
-      @content = null
-
-    execute: ()->
-      if not @validateSavedOperations()
-        return false
-      else
-        if @content instanceof types.Operation
-          @content.insert_parent = @
-        super()
-
-    #
-    # The result will be concatenated with the results from the other insert operations
-    # in order to retrieve the content of the engine.
-    # @see HistoryBuffer.toExecutedArray
-    #
-    val: (current_position)->
-      if @isDeleted() or not @content?
-        ""
-      else
-        @content
-
-    #
-    # Convert all relevant information of this operation to the json-format.
-    # This result can be send to other clients.
-    #
-    _encode: ()->
-      json =
-        {
-          'type': @type
-          'uid' : @getUid()
-          'prev': @prev_cl.getUid()
-          'next': @next_cl.getUid()
-          'origin': @origin.getUid()
-          'parent': @parent.getUid()
-        }
-
-      if @content?.getUid?
-        json['content'] = @content.getUid()
-      else
-        json['content'] = @content
-      json
-
-  types.TextInsert.parse = (json)->
-    {
-      'content' : content
-      'uid' : uid
-      'prev': prev
-      'next': next
-      'origin' : origin
-      'parent' : parent
-    } = json
-    new types.TextInsert content, uid, prev, next, origin, parent
-
-
-  class types.Array extends types.ListManager
-
-    type: "Array"
-
-    applyDelete: ()->
-      o = @end
-      while o?
-        o.applyDelete()
-        o = o.prev_cl
-      super()
-
-    cleanup: ()->
-      super()
-
-    toJson: (transform_to_value = false)->
-      val = @val()
-      for i, o in val
-        if o instanceof types.Object
-          o.toJson(transform_to_value)
-        else if o instanceof types.Array
-          o.toJson(transform_to_value)
-        else if transform_to_value and o instanceof types.Operation
-          o.val()
-        else
-          o
-
-    val: (pos)->
-      if pos?
-        o = @getOperationByPosition(pos+1)
-        if not (o instanceof types.Delimiter)
-          o.val()
-        else
-          throw new Error "this position does not exist"
-      else
-        o = @beginning.next_cl
-        result = []
-        while o isnt @end
-          if not o.isDeleted()
-            result.push o.val()
-          o = o.next_cl
-        result
-
-    push: (content)->
-      @insertAfter @end.prev_cl, content
-
-    insertAfter: (left, content, options)->
-      createContent = (content, options)->
-        if content? and content.constructor?
-          type = types[content.constructor.name]
-          if type? and type.create?
-            type.create content, options
-          else
-            throw new Error "The #{content.constructor.name}-type is not (yet) supported in Y."
-        else
-          content
-
-      right = left.next_cl
-      while right.isDeleted()
-        right = right.next_cl # find the first character to the right, that is not deleted. In the case that position is 0, its the Delimiter.
-      left = right.prev_cl
-
-      if content instanceof types.Operation
-        (new types.TextInsert content, undefined, left, right).execute()
-      else
-        for c in content
-          tmp = (new types.TextInsert createContent(c, options), undefined, left, right).execute()
-          left = tmp
-      @
-
-    #
-    # Inserts a string into the word.
-    #
-    # @return {Array Type} This String object.
-    #
-    insert: (position, content, options)->
-      ith = @getOperationByPosition position
-      # the (i-1)th character. e.g. "abc" the 1th character is "a"
-      # the 0th character is the left Delimiter
-      @insertAfter ith, [content], options
-
-    #
-    # Deletes a part of the word.
-    #
-    # @return {Array Type} This String object
-    #
-    delete: (position, length)->
-      o = @getOperationByPosition(position+1) # position 0 in this case is the deletion of the first character
-
-      delete_ops = []
-      for i in [0...length]
-        if o instanceof types.Delimiter
-          break
-        d = (new types.Delete undefined, o).execute()
-        o = o.next_cl
-        while (not (o instanceof types.Delimiter)) and o.isDeleted()
-          o = o.next_cl
-        delete_ops.push d._encode()
-      @
-
-    #
-    # @private
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json = {
-        'type': @type
-        'uid' : @getUid()
-      }
-      json
-
-  types.Array.parse = (json)->
-    {
-      'uid' : uid
-    } = json
-    new this(uid)
-
-  types.Array.create = (content, mutable)->
-    if (mutable is "mutable")
-      list = new types.Array().execute()
-      ith = list.getOperationByPosition 0
-      list.insertAfter ith, content
-      list
-    else if (not mutable?) or (mutable is "immutable")
-      content
-    else
-      throw new Error "Specify either \"mutable\" or \"immutable\"!!"
-
-  #
-  # Handles a String-like data structures with support for insert/delete at a word-position.
-  # @note Currently, only Text is supported!
-  #
-  class types.String extends types.Array
-
-    #
-    # @private
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    #
-    constructor: (uid)->
-      @textfields = []
-      super uid
-
-    #
-    # Identifies this class.
-    # Use it to check whether this is a word-type or something else.
-    #
-    # @example
-    #   var x = y.val('unknown')
-    #   if (x.type === "String") {
-    #     console.log JSON.stringify(x.toJson())
-    #   }
-    #
-    type: "String"
-
-    #
-    # Get the String-representation of this word.
-    # @return {String} The String-representation of this object.
-    #
-    val: ()->
-      c = for o in @toArray()
-        if o.val?
-          o.val()
-        else
-          ""
-      c.join('')
-
-    #
-    # Same as String.val
-    # @see String.val
-    #
-    toString: ()->
-      @val()
-
-    #
-    # Inserts a string into the word.
-    #
-    # @return {Array Type} This String object.
-    #
-    insert: (position, content, options)->
-      ith = @getOperationByPosition position
-      # the (i-1)th character. e.g. "abc" the 1th character is "a"
-      # the 0th character is the left Delimiter
-      @insertAfter ith, content, options
-
-    #
-    # Bind this String to a textfield or input field.
-    #
-    # @example
-    #   var textbox = document.getElementById("textfield");
-    #   y.bind(textbox);
-    #
-    bind: (textfield, dom_root)->
-      dom_root ?= window
-      if (not dom_root.getSelection?)
-        dom_root = window
-
-      # don't duplicate!
-      for t in @textfields
-        if t is textfield
-          return
-      creator_token = false;
-
-      word = @
-      textfield.value = @val()
-      @textfields.push textfield
-
-      if textfield.selectionStart? and textfield.setSelectionRange?
-        createRange = (fix)->
-          left = textfield.selectionStart
-          right = textfield.selectionEnd
-          if fix?
-            left = fix left
-            right = fix right
-          {
-            left: left
-            right: right
-          }
-
-        writeRange = (range)->
-          writeContent word.val()
-          textfield.setSelectionRange range.left, range.right
-
-        writeContent = (content)->
-          textfield.value = content
-      else
-        createRange = (fix)->
-          range = {}
-          s = dom_root.getSelection()
-          clength = textfield.textContent.length
-          range.left = Math.min s.anchorOffset, clength
-          range.right = Math.min s.focusOffset, clength
-          if fix?
-            range.left = fix range.left
-            range.right = fix range.right
-
-          edited_element = s.focusNode
-          if edited_element is textfield or edited_element is textfield.childNodes[0]
-            range.isReal = true
-          else
-            range.isReal = false
-          range
-
-        writeRange = (range)->
-          writeContent word.val()
-          textnode = textfield.childNodes[0]
-          if range.isReal and textnode?
-            if range.left < 0
-              range.left = 0
-            range.right = Math.max range.left, range.right
-            if range.right > textnode.length
-              range.right = textnode.length
-            range.left = Math.min range.left, range.right
-            r = document.createRange()
-            r.setStart(textnode, range.left)
-            r.setEnd(textnode, range.right)
-            s = window.getSelection()
-            s.removeAllRanges()
-            s.addRange(r)
-        writeContent = (content)->
-          append = ""
-          if content[content.length - 1] is " "
-            content = content.slice(0,content.length-1)
-            append = '&nbsp;'
-          textfield.textContent = content
-          textfield.innerHTML += append
-
-      writeContent this.val()
-
-      @observe (events)->
-        for event in events
-          if not creator_token
-            if event.type is "insert"
-              o_pos = event.position
-              fix = (cursor)->
-                if cursor <= o_pos
-                  cursor
-                else
-                  cursor += 1
-                  cursor
-              r = createRange fix
-              writeRange r
-
-            else if event.type is "delete"
-              o_pos = event.position
-              fix = (cursor)->
-                if cursor < o_pos
-                  cursor
-                else
-                  cursor -= 1
-                  cursor
-              r = createRange fix
-              writeRange r
-
-      # consume all text-insert changes.
-      textfield.onkeypress = (event)->
-        if word.is_deleted
-          # if word is deleted, do not do anything ever again
-          textfield.onkeypress = null
-          return true
-        creator_token = true
-        char = null
-        if event.key?
-          if event.charCode is 32
-            char = " "
-          else if event.keyCode is 13
-            char = '\n'
-          else
-            char = event.key
-        else
-          char = window.String.fromCharCode event.keyCode
-        if char.length > 1
-          return true
-        else if char.length > 0
-          r = createRange()
-          pos = Math.min r.left, r.right
-          diff = Math.abs(r.right - r.left)
-          word.delete pos, diff
-          word.insert pos, char
-          r.left = pos + char.length
-          r.right = r.left
-          writeRange r
-
-        event.preventDefault()
-        creator_token = false
-        false
-
-      textfield.onpaste = (event)->
-        if word.is_deleted
-          # if word is deleted, do not do anything ever again
-          textfield.onpaste = null
-          return true
-        event.preventDefault()
-      textfield.oncut = (event)->
-        if word.is_deleted
-          # if word is deleted, do not do anything ever again
-          textfield.oncut = null
-          return true
-        event.preventDefault()
-
-      #
-      # consume deletes. Note that
-      #   chrome: won't consume deletions on keypress event.
-      #   keyCode is deprecated. BUT: I don't see another way.
-      #     since event.key is not implemented in the current version of chrome.
-      #     Every browser supports keyCode. Let's stick with it for now..
-      #
-      textfield.onkeydown = (event)->
-        creator_token = true
-        if word.is_deleted
-          # if word is deleted, do not do anything ever again
-          textfield.onkeydown = null
-          return true
-        r = createRange()
-        pos = Math.min(r.left, r.right, word.val().length)
-        diff = Math.abs(r.left - r.right)
-        if event.keyCode? and event.keyCode is 8 # Backspace
-          if diff > 0
-            word.delete pos, diff
-            r.left = pos
-            r.right = pos
-            writeRange r
-          else
-            if event.ctrlKey? and event.ctrlKey
-              val = word.val()
-              new_pos = pos
-              del_length = 0
-              if pos > 0
-                new_pos--
-                del_length++
-              while new_pos > 0 and val[new_pos] isnt " " and val[new_pos] isnt '\n'
-                new_pos--
-                del_length++
-              word.delete new_pos, (pos-new_pos)
-              r.left = new_pos
-              r.right = new_pos
-              writeRange r
-            else
-              if pos > 0
-                word.delete (pos-1), 1
-                r.left = pos-1
-                r.right = pos-1
-                writeRange r
-          event.preventDefault()
-          creator_token = false
-          return false
-        else if event.keyCode? and event.keyCode is 46 # Delete
-          if diff > 0
-            word.delete pos, diff
-            r.left = pos
-            r.right = pos
-            writeRange r
-          else
-            word.delete pos, 1
-            r.left = pos
-            r.right = pos
-            writeRange r
-          event.preventDefault()
-          creator_token = false
-          return false
-        else
-          creator_token = false
-          true
-
-    #
-    # @private
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json = {
-        'type': @type
-        'uid' : @getUid()
-      }
-      json
-
-  types.String.parse = (json)->
-    {
-      'uid' : uid
-    } = json
-    new this(uid)
-
-  types.String.create = (content, mutable)->
-    if (mutable is "mutable")
-      word = new types.String().execute()
-      word.insert 0, content
-      word
-    else if (not mutable?) or (mutable is "immutable")
-      content
-    else
-      throw new Error "Specify either \"mutable\" or \"immutable\"!!"
-
-
-  structured_types
-
-

lib/Types/XmlTypes.unused

@@ -1,367 +0,0 @@
-###
-json_types_uninitialized = require "./JsonTypes"
-
-# some dom implementations may call another dom.method that simulates the behavior of another.
-# For example xml.insertChild(dom) , wich inserts an element at the end, and xml.insertAfter(dom,null) wich does the same
-# But Y's proxy may be called only once!
-proxy_token = false
-dont_proxy = (f)->
-  proxy_token = true
-  try
-    f()
-  catch e
-    proxy_token = false
-    throw new Error e
-  proxy_token = false
-
-_proxy = (f_name, f)->
-  old_f = @[f_name]
-  if old_f?
-    @[f_name] = ()->
-      if not proxy_token and not @_y?.isDeleted()
-        that = this
-        args = arguments
-        dont_proxy ()->
-          f.apply that, args
-          old_f.apply that, args
-      else
-        old_f.apply this, arguments
-  #else
-  #  @[f_name] = f
-Element?.prototype._proxy = _proxy
-
-
-module.exports = (HB)->
-  json_types = json_types_uninitialized HB
-  types = json_types.types
-  parser = json_types.parser
-
-  #
-  # Manages XML types
-  # Not supported:
-  # * Attribute nodes
-  # * Real replace of child elements (to much overhead). Currently, the new element is inserted after the 'replaced' element, and then it is deleted.
-  # * Namespaces (*NS)
-  # * Browser specific methods (webkit-* operations)
-  class XmlType extends types.Insert
-
-    constructor: (uid, @tagname, attributes, elements, @xml)->
-      ### In case you make this instanceof Insert again
-      if prev? and (not next?) and prev.type?
-        # adjust what you actually mean. you want to insert after prev, then
-        # next is not defined. but we only insert after non-deleted elements.
-        # This is also handled in TextInsert.
-        while prev.isDeleted()
-          prev = prev.prev_cl
-        next = prev.next_cl
-      ###
-
-      super(uid)
-
-
-      if @xml?._y?
-        d = new types.Delete undefined, @xml._y
-        HB.addOperation(d).execute()
-        @xml._y = null
-
-      if attributes? and elements?
-        @saveOperation 'attributes', attributes
-        @saveOperation 'elements', elements
-      else if (not attributes?) and (not elements?)
-        @attributes = new types.JsonType()
-        @attributes.setMutableDefault 'immutable'
-        HB.addOperation(@attributes).execute()
-        @elements = new types.WordType()
-        @elements.parent = @
-        HB.addOperation(@elements).execute()
-      else
-        throw new Error "Either define attribute and elements both, or none of them"
-
-      if @xml?
-        @tagname = @xml.tagName
-        for i in [0...@xml.attributes.length]
-          attr = xml.attributes[i]
-          @attributes.val(attr.name, attr.value)
-        for n in @xml.childNodes
-          if n.nodeType is n.TEXT_NODE
-            word = new TextNodeType(undefined, n)
-            HB.addOperation(word).execute()
-            @elements.push word
-          else if n.nodeType is n.ELEMENT_NODE
-            element = new XmlType undefined, undefined, undefined, undefined, n
-            HB.addOperation(element).execute()
-            @elements.push element
-          else
-            throw new Error "I don't know Node-type #{n.nodeType}!!"
-        @setXmlProxy()
-      undefined
-
-    #
-    # Identifies this class.
-    # Use it in order to check whether this is an xml-type or something else.
-    #
-    type: "XmlType"
-
-    applyDelete: (op)->
-      if @insert_parent? and not @insert_parent.isDeleted()
-        @insert_parent.applyDelete op
-      else
-        @attributes.applyDelete()
-        @elements.applyDelete()
-        super
-
-    cleanup: ()->
-      super()
-
-    setXmlProxy: ()->
-      @xml._y = @
-      that = @
-
-      @elements.on 'insert', (event, op)->
-        if op.creator isnt HB.getUserId() and this is that.elements
-          newNode = op.content.val()
-          right = op.next_cl
-          while right? and right.isDeleted()
-            right = right.next_cl
-          rightNode = null
-          if right.type isnt 'Delimiter'
-            rightNode = right.val().val()
-          dont_proxy ()->
-            that.xml.insertBefore newNode, rightNode
-      @elements.on 'delete', (event, op)->
-        del_op = op.deleted_by[0]
-        if del_op? and del_op.creator isnt HB.getUserId() and this is that.elements
-          deleted = op.content.val()
-          dont_proxy ()->
-            that.xml.removeChild deleted
-
-      @attributes.on ['add', 'update'], (event, property_name, op)->
-        if op.creator isnt HB.getUserId() and this is that.attributes
-          dont_proxy ()->
-            newval = op.val().val()
-            if newval?
-              that.xml.setAttribute(property_name, op.val().val())
-            else
-              that.xml.removeAttribute(property_name)
-
-
-
-
-
-
-
-
-      ## Here are all methods that proxy the behavior of the xml
-
-      # you want to find a specific child element. Since they are carried by an Insert-Type, you want to find that Insert-Operation.
-      # @param child {DomElement} Dom element.
-      # @return {InsertType} This carries the XmlType that represents the DomElement (child). false if i couldn't find it.
-      #
-      findNode = (child)->
-        if not child?
-          throw new Error "you must specify a parameter!"
-        child = child._y
-        elem = that.elements.beginning.next_cl
-        while elem.type isnt 'Delimiter' and elem.content isnt child
-          elem = elem.next_cl
-        if elem.type is 'Delimiter'
-          false
-        else
-          elem
-
-      insertBefore = (insertedNode_s, adjacentNode)->
-        next = null
-        if adjacentNode?
-          next = findNode adjacentNode
-        prev = null
-        if next
-          prev = next.prev_cl
-        else
-          prev = @_y.elements.end.prev_cl
-          while prev.isDeleted()
-            prev = prev.prev_cl
-        inserted_nodes = null
-        if insertedNode_s.nodeType is insertedNode_s.DOCUMENT_FRAGMENT_NODE
-          child = insertedNode_s.lastChild
-          while child?
-            element = new XmlType undefined, undefined, undefined, undefined, child
-            HB.addOperation(element).execute()
-            that.elements.insertAfter prev, element
-            child = child.previousSibling
-        else
-          element = new XmlType undefined, undefined, undefined, undefined, insertedNode_s
-          HB.addOperation(element).execute()
-          that.elements.insertAfter prev, element
-
-      @xml._proxy 'insertBefore', insertBefore
-      @xml._proxy 'appendChild', insertBefore
-      @xml._proxy 'removeAttribute', (name)->
-        that.attributes.val(name, undefined)
-      @xml._proxy 'setAttribute', (name, value)->
-        that.attributes.val name, value
-
-      renewClassList = (newclass)->
-        dont_do_it = false
-        if newclass?
-          for elem in this
-            if newclass is elem
-              dont_do_it = true
-        value = Array.prototype.join.call this, " "
-        if newclass? and not dont_do_it
-          value += " "+newclass
-        that.attributes.val('class', value )
-      _proxy.call @xml.classList, 'add', renewClassList
-      _proxy.call @xml.classList, 'remove', renewClassList
-      @xml.__defineSetter__ 'className', (val)->
-        @setAttribute('class', val)
-      @xml.__defineGetter__ 'className', ()->
-        that.attributes.val('class')
-      @xml.__defineSetter__ 'textContent', (val)->
-        # remove all nodes
-        elem = that.xml.firstChild
-        while elem?
-          remove = elem
-          elem = elem.nextSibling
-          that.xml.removeChild remove
-
-        # insert word content
-        if val isnt ""
-          text_node = document.createTextNode val
-          that.xml.appendChild text_node
-
-      removeChild = (node)->
-        elem = findNode node
-        if not elem
-          throw new Error "You are only allowed to delete existing (direct) child elements!"
-        d = new types.Delete undefined, elem
-        HB.addOperation(d).execute()
-        node._y = null
-      @xml._proxy 'removeChild', removeChild
-      @xml._proxy 'replaceChild', (insertedNode, replacedNode)->
-        insertBefore.call this, insertedNode, replacedNode
-        removeChild.call this, replacedNode
-
-
-
-    val: (enforce = false)->
-      if document?
-        if (not @xml?) or enforce
-          @xml = document.createElement @tagname
-
-          attr = @attributes.val()
-          for attr_name, value of attr
-            if value?
-              a = document.createAttribute attr_name
-              a.value = value
-              @xml.setAttributeNode a
-
-          e = @elements.beginning.next_cl
-          while e.type isnt "Delimiter"
-            n = e.content
-            if not e.isDeleted() and e.content? # TODO: how can this happen?  Probably because listeners
-              if n.type is "XmlType"
-                @xml.appendChild n.val(enforce)
-              else if n.type is "TextNodeType"
-                text_node = n.val()
-                @xml.appendChild text_node
-              else
-                throw new Error "Internal structure cannot be transformed to dom"
-            e = e.next_cl
-        @setXmlProxy()
-        @xml
-
-
-    execute: ()->
-      super()
-    ###
-      if not @validateSavedOperations()
-        return false
-      else
-
-        return true
-    ###
-
-    #
-    # Get the parent of this JsonType.
-    # @return {XmlType}
-    #
-    getParent: ()->
-      @parent
-
-    #
-    # @private
-    #
-    # Convert all relevant information of this operation to the json-format.
-    # This result can be send to other clients.
-    #
-    _encode: ()->
-      json =
-        {
-          'type' : @type
-          'attributes' : @attributes.getUid()
-          'elements' : @elements.getUid()
-          'tagname' : @tagname
-          'uid' : @getUid()
-        }
-      json
-
-  parser['XmlType'] = (json)->
-    {
-      'uid' : uid
-      'attributes' : attributes
-      'elements' : elements
-      'tagname' : tagname
-    } = json
-
-    new XmlType uid, tagname, attributes, elements, undefined
-
-#
-  # @nodoc
-  # Defines an object that is cannot be changed. You can use this to set an immutable string, or a number.
-  #
-  class TextNodeType extends types.ImmutableObject
-
-    #
-    # @param {Object} uid A unique identifier. If uid is undefined, a new uid will be created.
-    # @param {Object} content
-    #
-    constructor: (uid, content)->
-      if content._y?
-        d = new types.Delete undefined, content._y
-        HB.addOperation(d).execute()
-        content._y = null
-      content._y = @
-      super uid, content
-
-    applyDelete: (op)->
-      if @insert_parent? and not @insert_parent.isDeleted()
-        @insert_parent.applyDelete op
-      else
-        super
-
-
-    type: "TextNodeType"
-
-    #
-    # Encode this operation in such a way that it can be parsed by remote peers.
-    #
-    _encode: ()->
-      json = {
-        'type': @type
-        'uid' : @getUid()
-        'content' : @content.textContent
-      }
-      json
-
-  parser['TextNodeType'] = (json)->
-    {
-      'uid' : uid
-      'content' : content
-    } = json
-    textnode = document.createTextNode content
-    new TextNodeType uid, textnode
-
-  types['XmlType'] = XmlType
-
-  json_types
-###

lib/y-object.coffee

@@ -1,59 +0,0 @@
-
-Y = require './y'
-
-bindToChildren = (that)->
-  for i in [0...that.children.length]
-    attr = that.children.item(i)
-    if attr.name?
-      attr.val = that.val.val(attr.name)
-  that.val.observe (events)->
-    for event in events
-      if event.name?
-        for i in [0...that.children.length]
-          attr = that.children.item(i)
-          if attr.name? and attr.name is event.name
-            newVal = that.val.val(attr.name)
-            if attr.val isnt newVal
-              attr.val = newVal
-
-Polymer "y-object",
-  ready: ()->
-    if @connector?
-      @val = new Y @connector
-      bindToChildren @
-    else if @val?
-      bindToChildren @
-
-  valChanged: ()->
-    if @val? and @val.type is "Object"
-      bindToChildren @
-
-  connectorChanged: ()->
-    if (not @val?)
-      @val = new Y @connector
-      bindToChildren @
-
-Polymer "y-property",
-  ready: ()->
-    if @val? and @name?
-      if @val.constructor is Object
-        @val = @parentElement.val(@name,@val).val(@name)
-        # TODO: please use instanceof instead of .type,
-        # since it is more safe (consider someone putting a custom Object type here)
-      else if typeof @val is "string"
-        @parentElement.val(@name,@val)
-      if @val.type is "Object"
-        bindToChildren @
-
-  valChanged: ()->
-    if @val? and @name?
-      if @val.constructor is Object
-        @val = @parentElement.val.val(@name,@val).val(@name)
-        # TODO: please use instanceof instead of .type,
-        # since it is more safe (consider someone putting a custom Object type here)
-      else if @val.type is "Object"
-        bindToChildren @
-      else if @parentElement.val?.val? and @val isnt @parentElement.val.val(@name)
-        @parentElement.val.val @name, @val
-
-

lib/y.coffee

@@ -1,48 +0,0 @@
-
-json_types_uninitialized = require "./Types/JsonTypes"
-HistoryBuffer = require "./HistoryBuffer"
-Engine = require "./Engine"
-adaptConnector = require "./ConnectorAdapter"
-
-createY = (connector)->
-  user_id = null
-  if connector.user_id?
-    user_id = connector.user_id # TODO: change to getUniqueId()
-  else
-    user_id = "_temp"
-    connector.on_user_id_set = (id)->
-      user_id = id
-      HB.resetUserId id
-  HB = new HistoryBuffer user_id
-  type_manager = json_types_uninitialized HB
-  types = type_manager.types
-
-  #
-  # Framework for Json data-structures.
-  # Known values that are supported:
-  # * String
-  # * Integer
-  # * Array
-  #
-  class Y extends types.Object
-
-    #
-    # @param {String} user_id Unique id of the peer.
-    # @param {Connector} Connector the connector class.
-    #
-    constructor: ()->
-      @connector = connector
-      @HB = HB
-      @types = types
-      @engine = new Engine @HB, type_manager.types
-      adaptConnector @connector, @engine, @HB, type_manager.execution_listener
-      super
-
-    getConnector: ()->
-      @connector
-
-  return new Y(HB.getReservedUniqueIdentifier()).execute()
-
-module.exports = createY
-if window? and not window.Y?
-  window.Y = createY

package.json

@@ -1,66 +1,75 @@
 {
   "name": "yjs",
-  "version": "0.3.2",
-  "description": "A Framework that enables Real-Time Collaboration on arbitrary data structures.",
-  "main": "./build/node/y.js",
+  "version": "13.0.3",
+  "description": "Shared Editing Library",
+  "main": "./dist/yjs.cjs",
+  "module": "./dist/yjs.mjs",
+  "types": "./dist/src/index.d.ts",
+  "sideEffects": false,
   "scripts": {
-    "test": "./node_modules/.bin/gulp test"
+    "test": "npm run dist && node ./dist/tests.cjs --repitition-time 50",
+    "test-extensive": "npm run lint && npm run dist && node ./dist/tests.cjs --production --repitition-time 10000",
+    "dist": "rm -rf dist && rollup -c && tsc",
+    "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 && http-server ./docs/",
+    "preversion": "npm run lint && PRODUCTION=1 npm run dist && npm run docs && node ./dist/tests.cjs --repitition-time 1000",
+    "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/*",
+    "src/*",
+    "tests/*",
+    "docs/*"
+  ],
+  "dictionaries": {
+    "doc": "docs",
+    "test": "tests"
+  },
+  "standard": {
+    "ignore": [
+      "/dist",
+      "/node_modules",
+      "/docs"
+    ]
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/rwth-acis/yjs"
+    "url": "https://github.com/yjs/yjs.git"
   },
   "keywords": [
-    "OT",
-    "collaboration",
-    "Yata",
-    "synchronization",
-    "ShareJS",
-    "Coweb",
-    "concurrency"
+    "Yjs",
+    "CRDT",
+    "offline",
+    "shared editing",
+    "concurrency",
+    "collaboration"
   ],
   "author": "Kevin Jahns",
-  "email": "kevin.jahns@rwth-aachen.de",
+  "email": "kevin.jahns@protonmail.com",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/rwth-acis/yjs/issues"
+    "url": "https://github.com/yjs/yjs/issues"
   },
-  "homepage": "https://dadamonad.github.io/yjs/",
+  "homepage": "https://yjs.dev",
   "dependencies": {
+    "lib0": "^0.2.12"
   },
   "devDependencies": {
-    "codo": "^2.0.9",
-    "underscore": "^1.6.0",
-    "chai": "^1.9.1",
-    "codo": "^2.0.9",
-    "coffee-errors": "~0.8.6",
-    "coffee-script": "^1.7.1",
-    "coffeeify": "^0.6.0",
-    "gulp": "^3.8.7",
-    "gulp-browserify": "^0.5.0",
-    "gulp-cached": "^1.0.1",
-    "gulp-coffee": "^2.1.1",
-    "gulp-coffeeify": "^0.1.2",
-    "gulp-coffeelint": "^0.3.3",
-    "gulp-concat": "^2.3.4",
-    "gulp-copy": "0.0.2",
-    "gulp-debug": "^1.0.0",
-    "gulp-git": "^0.5.0",
-    "gulp-if": "^1.2.4",
-    "gulp-ignore": "^1.2.0",
-    "gulp-ljs": "^0.1.1",
-    "gulp-mocha": "^0.5.2",
-    "gulp-mocha-phantomjs": "^0.5.0",
-    "gulp-plumber": "^0.6.6",
-    "gulp-rename": "^1.2.0",
-    "gulp-rimraf": "^0.1.0",
-    "gulp-run": "^1.6.3",
-    "gulp-sourcemaps": "^1.1.1",
-    "gulp-uglify": "^0.3.1",
-    "gulp-watch": "^3.0.0",
-    "jquery": "^2.1.1",
-    "mocha": "^1.21.4",
-    "sinon": "^1.10.2",
-    "sinon-chai": "^2.5.0"
+    "@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",
+    "markdownlint-cli": "^0.19.0",
+    "rollup": "^1.30.0",
+    "rollup-cli": "^1.0.9",
+    "standard": "^14.0.0",
+    "tui-jsdoc-template": "^1.2.2",
+    "typescript": "^3.7.5",
+    "y-protocols": "^0.2.0"
   }
 }

rollup.config.js

@@ -0,0 +1,102 @@
+import nodeResolve from '@rollup/plugin-node-resolve'
+import commonjs from '@rollup/plugin-commonjs'
+
+const localImports = process.env.LOCALIMPORTS
+
+const customModules = new Set([
+  'y-websocket',
+  'y-codemirror',
+  'y-ace',
+  'y-textarea',
+  'y-quill',
+  'y-dom',
+  'y-prosemirror'
+])
+/**
+ * @type {Set<any>}
+ */
+const customLibModules = new Set([
+  'lib0',
+  'y-protocols'
+])
+const debugResolve = {
+  resolveId (importee) {
+    if (importee === 'yjs') {
+      return `${process.cwd()}/src/index.js`
+    }
+    if (localImports) {
+      if (customModules.has(importee.split('/')[0])) {
+        return `${process.cwd()}/../${importee}/src/${importee}.js`
+      }
+      if (customLibModules.has(importee.split('/')[0])) {
+        return `${process.cwd()}/../${importee}`
+      }
+    }
+    return null
+  }
+}
+
+export default [{
+  input: './src/index.js',
+  output: {
+    name: 'Y',
+    file: 'dist/yjs.cjs',
+    format: 'cjs',
+    sourcemap: true,
+    paths: path => {
+      if (/^lib0\//.test(path)) {
+        return `lib0/dist/${path.slice(5, -3)}.cjs`
+      }
+      return path
+    }
+  },
+  external: id => /^lib0\//.test(id)
+}, {
+  input: './src/index.js',
+  output: {
+    name: 'Y',
+    file: 'dist/yjs.mjs',
+    format: 'esm',
+    sourcemap: true,
+    paths: path => {
+      if (/^lib0\//.test(path)) {
+        return `lib0/dist/${path.slice(5, -3)}.cjs`
+      }
+      return path
+    }
+  },
+  external: id => /^lib0\//.test(id)
+}, {
+  input: './tests/index.js',
+  output: {
+    name: 'test',
+    file: 'dist/tests.js',
+    format: 'iife',
+    sourcemap: true
+  },
+  plugins: [
+    debugResolve,
+    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

@@ -0,0 +1,61 @@
+
+export {
+  Doc,
+  Transaction,
+  YArray as Array,
+  YMap as Map,
+  YText as Text,
+  YXmlText as XmlText,
+  YXmlHook as XmlHook,
+  YXmlElement as XmlElement,
+  YXmlFragment as XmlFragment,
+  YXmlEvent,
+  YMapEvent,
+  YArrayEvent,
+  YEvent,
+  Item,
+  AbstractStruct,
+  GC,
+  ContentBinary,
+  ContentDeleted,
+  ContentEmbed,
+  ContentFormat,
+  ContentJSON,
+  ContentAny,
+  ContentString,
+  ContentType,
+  AbstractType,
+  RelativePosition,
+  createRelativePositionFromTypeIndex,
+  createRelativePositionFromJSON,
+  createAbsolutePositionFromRelativePosition,
+  compareRelativePositions,
+  writeRelativePosition,
+  readRelativePosition,
+  ID,
+  createID,
+  compareIDs,
+  getState,
+  Snapshot,
+  createSnapshot,
+  createDeleteSet,
+  createDeleteSetFromStructStore,
+  snapshot,
+  emptySnapshot,
+  findRootTypeKey,
+  typeListToArraySnapshot,
+  typeMapGetSnapshot,
+  iterateDeletedStructs,
+  applyUpdate,
+  encodeStateAsUpdate,
+  encodeStateVector,
+  UndoManager,
+  decodeSnapshot,
+  encodeSnapshot,
+  isDeleted,
+  isParentOf,
+  equalSnapshots,
+  PermanentUserData, // @TODO experimental
+  tryGc,
+  transact
+} from './internals.js'

src/internals.js

@@ -0,0 +1,36 @@
+
+export * from './utils/DeleteSet.js'
+export * from './utils/Doc.js'
+export * from './utils/encoding.js'
+export * from './utils/EventHandler.js'
+export * from './utils/ID.js'
+export * from './utils/isParentOf.js'
+export * from './utils/PermanentUserData.js'
+export * from './utils/RelativePosition.js'
+export * from './utils/Snapshot.js'
+export * from './utils/StructStore.js'
+export * from './utils/Transaction.js'
+export * from './utils/UndoManager.js'
+export * from './utils/YEvent.js'
+
+export * from './types/AbstractType.js'
+export * from './types/YArray.js'
+export * from './types/YMap.js'
+export * from './types/YText.js'
+export * from './types/YXmlFragment.js'
+export * from './types/YXmlElement.js'
+export * from './types/YXmlEvent.js'
+export * from './types/YXmlHook.js'
+export * from './types/YXmlText.js'
+
+export * from './structs/AbstractStruct.js'
+export * from './structs/GC.js'
+export * from './structs/ContentBinary.js'
+export * from './structs/ContentDeleted.js'
+export * from './structs/ContentEmbed.js'
+export * from './structs/ContentFormat.js'
+export * from './structs/ContentJSON.js'
+export * from './structs/ContentAny.js'
+export * from './structs/ContentString.js'
+export * from './structs/ContentType.js'
+export * from './structs/Item.js'

src/structs/AbstractStruct.js

@@ -0,0 +1,93 @@
+
+import {
+  StructStore, ID, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js' // eslint-disable-line
+import * as error from 'lib0/error.js'
+
+/**
+ * @private
+ */
+export class AbstractStruct {
+  /**
+   * @param {ID} id
+   * @param {number} length
+   */
+  constructor (id, length) {
+    /**
+     * The uniqe identifier of this struct.
+     * @type {ID}
+     * @readonly
+     */
+    this.id = id
+    this.length = length
+    this.deleted = false
+  }
+
+  /**
+   * Merge this struct with the item to the right.
+   * This method is already assuming that `this.id.clock + this.length === this.id.clock`.
+   * Also this method does *not* remove right from StructStore!
+   * @param {AbstractStruct} right
+   * @return {boolean} wether this merged with right
+   */
+  mergeWith (right) {
+    return false
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder The encoder to write data to.
+   * @param {number} offset
+   * @param {number} encodingRef
+   * @private
+   */
+  write (encoder, offset, encodingRef) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {Transaction} transaction
+   */
+  integrate (transaction) {
+    throw error.methodUnimplemented()
+  }
+}
+
+/**
+ * @private
+ */
+export class AbstractStructRef {
+  /**
+   * @param {ID} id
+   */
+  constructor (id) {
+    /**
+     * @type {Array<ID>}
+     */
+    this._missing = []
+    /**
+     * The uniqe identifier of this type.
+     * @type {ID}
+     */
+    this.id = id
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @return {Array<ID|null>}
+   */
+  getMissing (transaction) {
+    return this._missing
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {StructStore} store
+   * @param {number} offset
+   * @return {AbstractStruct}
+   */
+  toStruct (transaction, store, offset) {
+    throw error.methodUnimplemented()
+  }
+}

src/structs/ContentAny.js

@@ -0,0 +1,116 @@
+import {
+  Transaction, Item, StructStore // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * @private
+ */
+export class ContentAny {
+  /**
+   * @param {Array<any>} arr
+   */
+  constructor (arr) {
+    /**
+     * @type {Array<any>}
+     */
+    this.arr = arr
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return this.arr.length
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return this.arr
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentAny}
+   */
+  copy () {
+    return new ContentAny(this.arr)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentAny}
+   */
+  splice (offset) {
+    const right = new ContentAny(this.arr.slice(offset))
+    this.arr = this.arr.slice(0, offset)
+    return right
+  }
+
+  /**
+   * @param {ContentAny} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    this.arr = this.arr.concat(right.arr)
+    return true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    const len = this.arr.length
+    encoding.writeVarUint(encoder, len - offset)
+    for (let i = offset; i < len; i++) {
+      const c = this.arr[i]
+      encoding.writeAny(encoder, c)
+    }
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 8
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentAny}
+ */
+export const readContentAny = decoder => {
+  const len = decoding.readVarUint(decoder)
+  const cs = []
+  for (let i = 0; i < len; i++) {
+    cs.push(decoding.readAny(decoder))
+  }
+  return new ContentAny(cs)
+}

src/structs/ContentBinary.js

@@ -0,0 +1,100 @@
+import {
+  StructStore, Item, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as buffer from 'lib0/buffer.js'
+import * as error from 'lib0/error.js'
+
+/**
+ * @private
+ */
+export class ContentBinary {
+  /**
+   * @param {Uint8Array} content
+   */
+  constructor (content) {
+    this.content = content
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return 1
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return [this.content]
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentBinary}
+   */
+  copy () {
+    return new ContentBinary(this.content)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentBinary}
+   */
+  splice (offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {ContentBinary} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    return false
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeVarUint8Array(encoder, this.content)
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 3
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentBinary}
+ */
+export const readContentBinary = decoder => new ContentBinary(buffer.copyUint8Array(decoding.readVarUint8Array(decoder)))

src/structs/ContentDeleted.js

@@ -0,0 +1,107 @@
+
+import {
+  addToDeleteSet,
+  StructStore, Item, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * @private
+ */
+export class ContentDeleted {
+  /**
+   * @param {number} len
+   */
+  constructor (len) {
+    this.len = len
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return this.len
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return []
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return false
+  }
+
+  /**
+   * @return {ContentDeleted}
+   */
+  copy () {
+    return new ContentDeleted(this.len)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentDeleted}
+   */
+  splice (offset) {
+    const right = new ContentDeleted(this.len - offset)
+    this.len = offset
+    return right
+  }
+
+  /**
+   * @param {ContentDeleted} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    this.len += right.len
+    return true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {
+    addToDeleteSet(transaction.deleteSet, item.id, this.len)
+    item.deleted = true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeVarUint(encoder, this.len - offset)
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 1
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentDeleted}
+ */
+export const readContentDeleted = decoder => new ContentDeleted(decoding.readVarUint(decoder))

src/structs/ContentEmbed.js

@@ -0,0 +1,100 @@
+
+import {
+  StructStore, Item, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as error from 'lib0/error.js'
+
+/**
+ * @private
+ */
+export class ContentEmbed {
+  /**
+   * @param {Object} embed
+   */
+  constructor (embed) {
+    this.embed = embed
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return 1
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return [this.embed]
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentEmbed}
+   */
+  copy () {
+    return new ContentEmbed(this.embed)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentEmbed}
+   */
+  splice (offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {ContentEmbed} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    return false
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeVarString(encoder, JSON.stringify(this.embed))
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 5
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentEmbed}
+ */
+export const readContentEmbed = decoder => new ContentEmbed(JSON.parse(decoding.readVarString(decoder)))

src/structs/ContentFormat.js

@@ -0,0 +1,103 @@
+
+import {
+  Item, StructStore, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as error from 'lib0/error.js'
+
+/**
+ * @private
+ */
+export class ContentFormat {
+  /**
+   * @param {string} key
+   * @param {Object} value
+   */
+  constructor (key, value) {
+    this.key = key
+    this.value = value
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return 1
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return []
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return false
+  }
+
+  /**
+   * @return {ContentFormat}
+   */
+  copy () {
+    return new ContentFormat(this.key, this.value)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentFormat}
+   */
+  splice (offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {ContentFormat} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    return false
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeVarString(encoder, this.key)
+    encoding.writeVarString(encoder, JSON.stringify(this.value))
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 6
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentFormat}
+ */
+export const readContentFormat = decoder => new ContentFormat(decoding.readVarString(decoder), JSON.parse(decoding.readVarString(decoder)))

src/structs/ContentJSON.js

@@ -0,0 +1,121 @@
+import {
+  Transaction, Item, StructStore // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * @private
+ */
+export class ContentJSON {
+  /**
+   * @param {Array<any>} arr
+   */
+  constructor (arr) {
+    /**
+     * @type {Array<any>}
+     */
+    this.arr = arr
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return this.arr.length
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return this.arr
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentJSON}
+   */
+  copy () {
+    return new ContentJSON(this.arr)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentJSON}
+   */
+  splice (offset) {
+    const right = new ContentJSON(this.arr.slice(offset))
+    this.arr = this.arr.slice(0, offset)
+    return right
+  }
+
+  /**
+   * @param {ContentJSON} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    this.arr = this.arr.concat(right.arr)
+    return true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    const len = this.arr.length
+    encoding.writeVarUint(encoder, len - offset)
+    for (let i = offset; i < len; i++) {
+      const c = this.arr[i]
+      encoding.writeVarString(encoder, c === undefined ? 'undefined' : JSON.stringify(c))
+    }
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 2
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentJSON}
+ */
+export const readContentJSON = decoder => {
+  const len = decoding.readVarUint(decoder)
+  const cs = []
+  for (let i = 0; i < len; i++) {
+    const c = decoding.readVarString(decoder)
+    if (c === 'undefined') {
+      cs.push(undefined)
+    } else {
+      cs.push(JSON.parse(c))
+    }
+  }
+  return new ContentJSON(cs)
+}

src/structs/ContentString.js

@@ -0,0 +1,104 @@
+import {
+  Transaction, Item, StructStore // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * @private
+ */
+export class ContentString {
+  /**
+   * @param {string} str
+   */
+  constructor (str) {
+    /**
+     * @type {string}
+     */
+    this.str = str
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return this.str.length
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return this.str.split('')
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentString}
+   */
+  copy () {
+    return new ContentString(this.str)
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentString}
+   */
+  splice (offset) {
+    const right = new ContentString(this.str.slice(offset))
+    this.str = this.str.slice(0, offset)
+    return right
+  }
+
+  /**
+   * @param {ContentString} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    this.str += right.str
+    return true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {}
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {}
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {}
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeVarString(encoder, offset === 0 ? this.str : this.str.slice(offset))
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 4
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentString}
+ */
+export const readContentString = decoder => new ContentString(decoding.readVarString(decoder))

src/structs/ContentType.js

@@ -0,0 +1,174 @@
+
+import {
+  readYArray,
+  readYMap,
+  readYText,
+  readYXmlElement,
+  readYXmlFragment,
+  readYXmlHook,
+  readYXmlText,
+  StructStore, Transaction, Item, YEvent, AbstractType // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js' // eslint-disable-line
+import * as decoding from 'lib0/decoding.js'
+import * as error from 'lib0/error.js'
+
+/**
+ * @type {Array<function(decoding.Decoder):AbstractType<any>>}
+ * @private
+ */
+export const typeRefs = [
+  readYArray,
+  readYMap,
+  readYText,
+  readYXmlElement,
+  readYXmlFragment,
+  readYXmlHook,
+  readYXmlText
+]
+
+export const YArrayRefID = 0
+export const YMapRefID = 1
+export const YTextRefID = 2
+export const YXmlElementRefID = 3
+export const YXmlFragmentRefID = 4
+export const YXmlHookRefID = 5
+export const YXmlTextRefID = 6
+
+/**
+ * @private
+ */
+export class ContentType {
+  /**
+   * @param {AbstractType<YEvent>} type
+   */
+  constructor (type) {
+    /**
+     * @type {AbstractType<any>}
+     */
+    this.type = type
+  }
+
+  /**
+   * @return {number}
+   */
+  getLength () {
+    return 1
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    return [this.type]
+  }
+
+  /**
+   * @return {boolean}
+   */
+  isCountable () {
+    return true
+  }
+
+  /**
+   * @return {ContentType}
+   */
+  copy () {
+    return new ContentType(this.type._copy())
+  }
+
+  /**
+   * @param {number} offset
+   * @return {ContentType}
+   */
+  splice (offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {ContentType} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    return false
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {
+    this.type._integrate(transaction.doc, item)
+  }
+
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {
+    let item = this.type._start
+    while (item !== null) {
+      if (!item.deleted) {
+        item.delete(transaction)
+      } else {
+        // Whis will be gc'd later and we want to merge it if possible
+        // We try to merge all deleted items after each transaction,
+        // but we have no knowledge about that this needs to be merged
+        // since it is not in transaction.ds. Hence we add it to transaction._mergeStructs
+        transaction._mergeStructs.add(item.id)
+      }
+      item = item.right
+    }
+    this.type._map.forEach(item => {
+      if (!item.deleted) {
+        item.delete(transaction)
+      } else {
+        // same as above
+        transaction._mergeStructs.add(item.id)
+      }
+    })
+    transaction.changed.delete(this.type)
+  }
+
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {
+    let item = this.type._start
+    while (item !== null) {
+      item.gc(store, true)
+      item = item.right
+    }
+    this.type._start = null
+    this.type._map.forEach(/** @param {Item | null} item */ (item) => {
+      while (item !== null) {
+        item.gc(store, true)
+        item = item.left
+      }
+    })
+    this.type._map = new Map()
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    this.type._write(encoder)
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    return 7
+  }
+}
+
+/**
+ * @private
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ContentType}
+ */
+export const readContentType = decoder => new ContentType(typeRefs[decoding.readVarUint(decoder)](decoder))

src/structs/GC.js

@@ -0,0 +1,90 @@
+
+import {
+  AbstractStructRef,
+  AbstractStruct,
+  createID,
+  addStruct,
+  StructStore, Transaction, ID // eslint-disable-line
+} from '../internals.js'
+
+import * as decoding from 'lib0/decoding.js'
+import * as encoding from 'lib0/encoding.js'
+
+export const structGCRefNumber = 0
+
+/**
+ * @private
+ */
+export class GC extends AbstractStruct {
+  /**
+   * @param {ID} id
+   * @param {number} length
+   */
+  constructor (id, length) {
+    super(id, length)
+    this.deleted = true
+  }
+
+  delete () {}
+
+  /**
+   * @param {GC} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    this.length += right.length
+    return true
+  }
+
+  /**
+   * @param {Transaction} transaction
+   */
+  integrate (transaction) {
+    addStruct(transaction.doc.store, this)
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    encoding.writeUint8(encoder, structGCRefNumber)
+    encoding.writeVarUint(encoder, this.length - offset)
+  }
+}
+
+/**
+ * @private
+ */
+export class GCRef extends AbstractStructRef {
+  /**
+   * @param {decoding.Decoder} decoder
+   * @param {ID} id
+   * @param {number} info
+   */
+  constructor (decoder, id, info) {
+    super(id)
+    /**
+     * @type {number}
+     */
+    this.length = decoding.readVarUint(decoder)
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {StructStore} store
+   * @param {number} offset
+   * @return {GC}
+   */
+  toStruct (transaction, store, offset) {
+    if (offset > 0) {
+      // @ts-ignore
+      this.id = createID(this.id.client, this.id.clock + offset)
+      this.length -= offset
+    }
+    return new GC(
+      this.id,
+      this.length
+    )
+  }
+}

src/structs/Item.js

@@ -0,0 +1,785 @@
+
+import {
+  readID,
+  createID,
+  writeID,
+  GC,
+  nextID,
+  AbstractStructRef,
+  AbstractStruct,
+  replaceStruct,
+  addStruct,
+  addToDeleteSet,
+  findRootTypeKey,
+  compareIDs,
+  getItem,
+  getItemCleanEnd,
+  getItemCleanStart,
+  readContentDeleted,
+  readContentBinary,
+  readContentJSON,
+  readContentAny,
+  readContentString,
+  readContentEmbed,
+  readContentFormat,
+  readContentType,
+  addChangedTypeToTransaction,
+  ContentType, ContentDeleted, StructStore, ID, AbstractType, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as error from 'lib0/error.js'
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as maplib from 'lib0/map.js'
+import * as set from 'lib0/set.js'
+import * as binary from 'lib0/binary.js'
+
+/**
+ * @todo This should return several items
+ *
+ * @param {StructStore} store
+ * @param {ID} id
+ * @return {{item:Item, diff:number}}
+ */
+export const followRedone = (store, id) => {
+  /**
+   * @type {ID|null}
+   */
+  let nextID = id
+  let diff = 0
+  let item
+  do {
+    if (diff > 0) {
+      nextID = createID(nextID.client, nextID.clock + diff)
+    }
+    item = getItem(store, nextID)
+    diff = nextID.clock - item.id.clock
+    nextID = item.redone
+  } while (nextID !== null && item instanceof Item)
+  return {
+    item, diff
+  }
+}
+
+/**
+ * Make sure that neither item nor any of its parents is ever deleted.
+ *
+ * This property does not persist when storing it into a database or when
+ * sending it to other peers
+ *
+ * @param {Item|null} item
+ * @param {boolean} keep
+ */
+export const keepItem = (item, keep) => {
+  while (item !== null && item.keep !== keep) {
+    item.keep = keep
+    item = item.parent._item
+  }
+}
+
+/**
+ * Split leftItem into two items
+ * @param {Transaction} transaction
+ * @param {Item} leftItem
+ * @param {number} diff
+ * @return {Item}
+ *
+ * @function
+ * @private
+ */
+export const splitItem = (transaction, leftItem, diff) => {
+  const id = leftItem.id
+  // create rightItem
+  const rightItem = new Item(
+    createID(id.client, id.clock + diff),
+    leftItem,
+    createID(id.client, id.clock + diff - 1),
+    leftItem.right,
+    leftItem.rightOrigin,
+    leftItem.parent,
+    leftItem.parentSub,
+    leftItem.content.splice(diff)
+  )
+  if (leftItem.deleted) {
+    rightItem.deleted = true
+  }
+  if (leftItem.keep) {
+    rightItem.keep = true
+  }
+  if (leftItem.redone !== null) {
+    rightItem.redone = createID(leftItem.redone.client, leftItem.redone.clock + diff)
+  }
+  // update left (do not set leftItem.rightOrigin as it will lead to problems when syncing)
+  leftItem.right = rightItem
+  // update right
+  if (rightItem.right !== null) {
+    rightItem.right.left = rightItem
+  }
+  // right is more specific.
+  transaction._mergeStructs.add(rightItem.id)
+  // update parent._map
+  if (rightItem.parentSub !== null && rightItem.right === null) {
+    rightItem.parent._map.set(rightItem.parentSub, rightItem)
+  }
+  leftItem.length = diff
+  return rightItem
+}
+
+/**
+ * Redoes the effect of this operation.
+ *
+ * @param {Transaction} transaction The Yjs instance.
+ * @param {Item} item
+ * @param {Set<Item>} redoitems
+ *
+ * @return {Item|null}
+ *
+ * @private
+ */
+export const redoItem = (transaction, item, redoitems) => {
+  if (item.redone !== null) {
+    return getItemCleanStart(transaction, item.redone)
+  }
+  let parentItem = item.parent._item
+  /**
+   * @type {Item|null}
+   */
+  let left
+  /**
+   * @type {Item|null}
+   */
+  let right
+  if (item.parentSub === null) {
+    // Is an array item. Insert at the old position
+    left = item.left
+    right = item
+  } else {
+    // Is a map item. Insert as current value
+    left = item
+    while (left.right !== null) {
+      left = left.right
+      if (left.id.client !== transaction.doc.clientID) {
+        // It is not possible to redo this item because it conflicts with a
+        // change from another client
+        return null
+      }
+    }
+    if (left.right !== null) {
+      left = /** @type {Item} */ (item.parent._map.get(item.parentSub))
+    }
+    right = null
+  }
+  // make sure that parent is redone
+  if (parentItem !== null && parentItem.deleted === true && parentItem.redone === null) {
+    // try to undo parent if it will be undone anyway
+    if (!redoitems.has(parentItem) || redoItem(transaction, parentItem, redoitems) === null) {
+      return null
+    }
+  }
+  if (parentItem !== null && parentItem.redone !== null) {
+    while (parentItem.redone !== null) {
+      parentItem = getItemCleanStart(transaction, parentItem.redone)
+    }
+    // find next cloned_redo items
+    while (left !== null) {
+      /**
+       * @type {Item|null}
+       */
+      let leftTrace = left
+      // trace redone until parent matches
+      while (leftTrace !== null && leftTrace.parent._item !== parentItem) {
+        leftTrace = leftTrace.redone === null ? null : getItemCleanStart(transaction, leftTrace.redone)
+      }
+      if (leftTrace !== null && leftTrace.parent._item === parentItem) {
+        left = leftTrace
+        break
+      }
+      left = left.left
+    }
+    while (right !== null) {
+      /**
+       * @type {Item|null}
+       */
+      let rightTrace = right
+      // trace redone until parent matches
+      while (rightTrace !== null && rightTrace.parent._item !== parentItem) {
+        rightTrace = rightTrace.redone === null ? null : getItemCleanStart(transaction, rightTrace.redone)
+      }
+      if (rightTrace !== null && rightTrace.parent._item === parentItem) {
+        right = rightTrace
+        break
+      }
+      right = right.right
+    }
+  }
+  const redoneItem = new Item(
+    nextID(transaction),
+    left, left === null ? null : left.lastId,
+    right, right === null ? null : right.id,
+    parentItem === null ? item.parent : /** @type {ContentType} */ (parentItem.content).type,
+    item.parentSub,
+    item.content.copy()
+  )
+  item.redone = redoneItem.id
+  keepItem(redoneItem, true)
+  redoneItem.integrate(transaction)
+  return redoneItem
+}
+
+/**
+ * Abstract class that represents any content.
+ */
+export class Item extends AbstractStruct {
+  /**
+   * @param {ID} id
+   * @param {Item | null} left
+   * @param {ID | null} origin
+   * @param {Item | null} right
+   * @param {ID | null} rightOrigin
+   * @param {AbstractType<any>} parent
+   * @param {string | null} parentSub
+   * @param {AbstractContent} content
+   */
+  constructor (id, left, origin, right, rightOrigin, parent, parentSub, content) {
+    super(id, content.getLength())
+    /**
+     * The item that was originally to the left of this item.
+     * @type {ID | null}
+     * @readonly
+     */
+    this.origin = origin
+    /**
+     * The item that is currently to the left of this item.
+     * @type {Item | null}
+     */
+    this.left = left
+    /**
+     * The item that is currently to the right of this item.
+     * @type {Item | null}
+     */
+    this.right = right
+    /**
+     * The item that was originally to the right of this item.
+     * @readonly
+     * @type {ID | null}
+     */
+    this.rightOrigin = rightOrigin
+    /**
+     * The parent type.
+     * @type {AbstractType<any>}
+     * @readonly
+     */
+    this.parent = parent
+    /**
+     * If the parent refers to this item with some kind of key (e.g. YMap, the
+     * key is specified here. The key is then used to refer to the list in which
+     * to insert this item. If `parentSub = null` type._start is the list in
+     * which to insert to. Otherwise it is `parent._map`.
+     * @type {String | null}
+     * @readonly
+     */
+    this.parentSub = parentSub
+    /**
+     * Whether this item was deleted or not.
+     * @type {Boolean}
+     */
+    this.deleted = false
+    /**
+     * If this type's effect is reundone this type refers to the type that undid
+     * this operation.
+     * @type {ID | null}
+     */
+    this.redone = null
+    /**
+     * @type {AbstractContent}
+     */
+    this.content = content
+    this.length = content.getLength()
+    this.countable = content.isCountable()
+    /**
+     * If true, do not garbage collect this Item.
+     */
+    this.keep = false
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @private
+   */
+  integrate (transaction) {
+    const store = transaction.doc.store
+    const id = this.id
+    const parent = this.parent
+    const parentSub = this.parentSub
+    const length = this.length
+    /**
+     * @type {Item|null}
+     */
+    let o
+    // set o to the first conflicting item
+    if (this.left !== null) {
+      o = this.left.right
+    } else if (parentSub !== null) {
+      o = parent._map.get(parentSub) || null
+      while (o !== null && o.left !== null) {
+        o = o.left
+      }
+    } else {
+      o = parent._start
+    }
+    // TODO: use something like DeleteSet here (a tree implementation would be best)
+    /**
+     * @type {Set<Item>}
+     */
+    const conflictingItems = new Set()
+    /**
+     * @type {Set<Item>}
+     */
+    const itemsBeforeOrigin = new Set()
+    // Let c in conflictingItems, b in itemsBeforeOrigin
+    // ***{origin}bbbb{this}{c,b}{c,b}{o}***
+    // Note that conflictingItems is a subset of itemsBeforeOrigin
+    while (o !== null && o !== this.right) {
+      itemsBeforeOrigin.add(o)
+      conflictingItems.add(o)
+      if (compareIDs(this.origin, o.origin)) {
+        // case 1
+        if (o.id.client < id.client) {
+          this.left = o
+          conflictingItems.clear()
+        }
+      } else if (o.origin !== null && itemsBeforeOrigin.has(getItem(store, o.origin))) {
+        // case 2
+        if (o.origin === null || !conflictingItems.has(getItem(store, o.origin))) {
+          this.left = o
+          conflictingItems.clear()
+        }
+      } else {
+        break
+      }
+      o = o.right
+    }
+    // reconnect left/right + update parent map/start if necessary
+    if (this.left !== null) {
+      const right = this.left.right
+      this.right = right
+      this.left.right = this
+    } else {
+      let r
+      if (parentSub !== null) {
+        r = parent._map.get(parentSub) || null
+        while (r !== null && r.left !== null) {
+          r = r.left
+        }
+      } else {
+        r = parent._start
+        parent._start = this
+      }
+      this.right = r
+    }
+    if (this.right !== null) {
+      this.right.left = this
+    } else if (parentSub !== null) {
+      // set as current parent value if right === null and this is parentSub
+      parent._map.set(parentSub, this)
+      if (this.left !== null) {
+        // this is the current attribute value of parent. delete right
+        this.left.delete(transaction)
+      }
+    }
+    // adjust length of parent
+    if (parentSub === null && this.countable && !this.deleted) {
+      parent._length += length
+    }
+    addStruct(store, this)
+    this.content.integrate(transaction, this)
+    // add parent to transaction.changed
+    addChangedTypeToTransaction(transaction, parent, parentSub)
+    if ((parent._item !== null && parent._item.deleted) || (this.right !== null && parentSub !== null)) {
+      // delete if parent is deleted or if this is not the current attribute value of parent
+      this.delete(transaction)
+    }
+  }
+
+  /**
+   * Returns the next non-deleted item
+   * @private
+   */
+  get next () {
+    let n = this.right
+    while (n !== null && n.deleted) {
+      n = n.right
+    }
+    return n
+  }
+
+  /**
+   * Returns the previous non-deleted item
+   * @private
+   */
+  get prev () {
+    let n = this.left
+    while (n !== null && n.deleted) {
+      n = n.left
+    }
+    return n
+  }
+
+  /**
+   * Computes the last content address of this Item.
+   */
+  get lastId () {
+    return createID(this.id.client, this.id.clock + this.length - 1)
+  }
+
+  /**
+   * Try to merge two items
+   *
+   * @param {Item} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    if (
+      compareIDs(right.origin, this.lastId) &&
+      this.right === right &&
+      compareIDs(this.rightOrigin, right.rightOrigin) &&
+      this.id.client === right.id.client &&
+      this.id.clock + this.length === right.id.clock &&
+      this.deleted === right.deleted &&
+      this.redone === null &&
+      right.redone === null &&
+      this.content.constructor === right.content.constructor &&
+      this.content.mergeWith(right.content)
+    ) {
+      if (right.keep) {
+        this.keep = true
+      }
+      this.right = right.right
+      if (this.right !== null) {
+        this.right.left = this
+      }
+      this.length += right.length
+      return true
+    }
+    return false
+  }
+
+  /**
+   * Mark this Item as deleted.
+   *
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {
+    if (!this.deleted) {
+      const parent = this.parent
+      // adjust the length of parent
+      if (this.countable && this.parentSub === null) {
+        parent._length -= this.length
+      }
+      this.deleted = true
+      addToDeleteSet(transaction.deleteSet, this.id, this.length)
+      maplib.setIfUndefined(transaction.changed, parent, set.create).add(this.parentSub)
+      this.content.delete(transaction)
+    }
+  }
+
+  /**
+   * @param {StructStore} store
+   * @param {boolean} parentGCd
+   *
+   * @private
+   */
+  gc (store, parentGCd) {
+    if (!this.deleted) {
+      throw error.unexpectedCase()
+    }
+    this.content.gc(store)
+    if (parentGCd) {
+      replaceStruct(store, this, new GC(this.id, this.length))
+    } else {
+      this.content = new ContentDeleted(this.length)
+    }
+  }
+
+  /**
+   * Transform the properties of this type to binary and write it to an
+   * BinaryEncoder.
+   *
+   * This is called when this Item is sent to a remote peer.
+   *
+   * @param {encoding.Encoder} encoder The encoder to write data to.
+   * @param {number} offset
+   *
+   * @private
+   */
+  write (encoder, offset) {
+    const origin = offset > 0 ? createID(this.id.client, this.id.clock + offset - 1) : this.origin
+    const rightOrigin = this.rightOrigin
+    const parentSub = this.parentSub
+    const info = (this.content.getRef() & binary.BITS5) |
+      (origin === null ? 0 : binary.BIT8) | // origin is defined
+      (rightOrigin === null ? 0 : binary.BIT7) | // right origin is defined
+      (parentSub === null ? 0 : binary.BIT6) // parentSub is non-null
+    encoding.writeUint8(encoder, info)
+    if (origin !== null) {
+      writeID(encoder, origin)
+    }
+    if (rightOrigin !== null) {
+      writeID(encoder, rightOrigin)
+    }
+    if (origin === null && rightOrigin === null) {
+      const parent = this.parent
+      if (parent._item === null) {
+        // parent type on y._map
+        // find the correct key
+        const ykey = findRootTypeKey(parent)
+        encoding.writeVarUint(encoder, 1) // write parentYKey
+        encoding.writeVarString(encoder, ykey)
+      } else {
+        encoding.writeVarUint(encoder, 0) // write parent id
+        writeID(encoder, parent._item.id)
+      }
+      if (parentSub !== null) {
+        encoding.writeVarString(encoder, parentSub)
+      }
+    }
+    this.content.write(encoder, offset)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @param {number} info
+ */
+const readItemContent = (decoder, info) => contentRefs[info & binary.BITS5](decoder)
+
+/**
+ * A lookup map for reading Item content.
+ *
+ * @type {Array<function(decoding.Decoder):AbstractContent>}
+ */
+export const contentRefs = [
+  () => { throw error.unexpectedCase() }, // GC is not ItemContent
+  readContentDeleted,
+  readContentJSON,
+  readContentBinary,
+  readContentString,
+  readContentEmbed,
+  readContentFormat,
+  readContentType,
+  readContentAny
+]
+
+/**
+ * Do not implement this class!
+ */
+export class AbstractContent {
+  /**
+   * @return {number}
+   */
+  getLength () {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @return {Array<any>}
+   */
+  getContent () {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * Should return false if this Item is some kind of meta information
+   * (e.g. format information).
+   *
+   * * Whether this Item should be addressable via `yarray.get(i)`
+   * * Whether this Item should be counted when computing yarray.length
+   *
+   * @return {boolean}
+   */
+  isCountable () {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @return {AbstractContent}
+   */
+  copy () {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {number} offset
+   * @return {AbstractContent}
+   */
+  splice (offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {AbstractContent} right
+   * @return {boolean}
+   */
+  mergeWith (right) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {Item} item
+   */
+  integrate (transaction, item) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {Transaction} transaction
+   */
+  delete (transaction) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {StructStore} store
+   */
+  gc (store) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   * @param {number} offset
+   */
+  write (encoder, offset) {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @return {number}
+   */
+  getRef () {
+    throw error.methodUnimplemented()
+  }
+}
+
+/**
+ * @private
+ */
+export class ItemRef extends AbstractStructRef {
+  /**
+   * @param {decoding.Decoder} decoder
+   * @param {ID} id
+   * @param {number} info
+   */
+  constructor (decoder, id, info) {
+    super(id)
+    /**
+     * The item that was originally to the left of this item.
+     * @type {ID | null}
+     */
+    this.left = (info & binary.BIT8) === binary.BIT8 ? readID(decoder) : null
+    /**
+     * The item that was originally to the right of this item.
+     * @type {ID | null}
+     */
+    this.right = (info & binary.BIT7) === binary.BIT7 ? readID(decoder) : null
+    const canCopyParentInfo = (info & (binary.BIT7 | binary.BIT8)) === 0
+    const hasParentYKey = canCopyParentInfo ? decoding.readVarUint(decoder) === 1 : false
+    /**
+     * If parent = null and neither left nor right are defined, then we know that `parent` is child of `y`
+     * and we read the next string as parentYKey.
+     * It indicates how we store/retrieve parent from `y.share`
+     * @type {string|null}
+     */
+    this.parentYKey = canCopyParentInfo && hasParentYKey ? decoding.readVarString(decoder) : null
+    /**
+     * The parent type.
+     * @type {ID | null}
+     */
+    this.parent = canCopyParentInfo && !hasParentYKey ? readID(decoder) : null
+    /**
+     * If the parent refers to this item with some kind of key (e.g. YMap, the
+     * key is specified here. The key is then used to refer to the list in which
+     * to insert this item. If `parentSub = null` type._start is the list in
+     * which to insert to. Otherwise it is `parent._map`.
+     * @type {String | null}
+     */
+    this.parentSub = canCopyParentInfo && (info & binary.BIT6) === binary.BIT6 ? decoding.readVarString(decoder) : null
+    const missing = this._missing
+    if (this.left !== null) {
+      missing.push(this.left)
+    }
+    if (this.right !== null) {
+      missing.push(this.right)
+    }
+    if (this.parent !== null) {
+      missing.push(this.parent)
+    }
+    /**
+     * @type {AbstractContent}
+     */
+    this.content = readItemContent(decoder, info)
+    this.length = this.content.getLength()
+  }
+
+  /**
+   * @param {Transaction} transaction
+   * @param {StructStore} store
+   * @param {number} offset
+   * @return {Item|GC}
+   */
+  toStruct (transaction, store, offset) {
+    if (offset > 0) {
+      /**
+       * @type {ID}
+       */
+      const id = this.id
+      this.id = createID(id.client, id.clock + offset)
+      this.left = createID(this.id.client, this.id.clock - 1)
+      this.content = this.content.splice(offset)
+      this.length -= offset
+    }
+
+    const left = this.left === null ? null : getItemCleanEnd(transaction, store, this.left)
+    const right = this.right === null ? null : getItemCleanStart(transaction, this.right)
+    let parent = null
+    let parentSub = this.parentSub
+    if (this.parent !== null) {
+      const parentItem = getItem(store, this.parent)
+      // Edge case: toStruct is called with an offset > 0. In this case left is defined.
+      // Depending in which order structs arrive, left may be GC'd and the parent not
+      // deleted. This is why we check if left is GC'd. Strictly we don't have
+      // to check if right is GC'd, but we will in case we run into future issues
+      if (!parentItem.deleted && (left === null || left.constructor !== GC) && (right === null || right.constructor !== GC)) {
+        parent = /** @type {ContentType} */ (parentItem.content).type
+      }
+    } else if (this.parentYKey !== null) {
+      parent = transaction.doc.get(this.parentYKey)
+    } else if (left !== null) {
+      if (left.constructor !== GC) {
+        parent = left.parent
+        parentSub = left.parentSub
+      }
+    } else if (right !== null) {
+      if (right.constructor !== GC) {
+        parent = right.parent
+        parentSub = right.parentSub
+      }
+    } else {
+      throw error.unexpectedCase()
+    }
+
+    return parent === null
+      ? new GC(this.id, this.length)
+      : new Item(
+        this.id,
+        left,
+        this.left,
+        right,
+        this.right,
+        parent,
+        parentSub,
+        this.content
+      )
+  }
+}

src/types/AbstractType.js

@@ -0,0 +1,601 @@
+
+import {
+  removeEventHandlerListener,
+  callEventHandlerListeners,
+  addEventHandlerListener,
+  createEventHandler,
+  nextID,
+  isVisible,
+  ContentType,
+  ContentAny,
+  ContentBinary,
+  createID,
+  getItemCleanStart,
+  Doc, Snapshot, Transaction, EventHandler, YEvent, Item, // eslint-disable-line
+} from '../internals.js'
+
+import * as map from 'lib0/map.js'
+import * as iterator from 'lib0/iterator.js'
+import * as error from 'lib0/error.js'
+import * as encoding from 'lib0/encoding.js' // eslint-disable-line
+
+/**
+ * Call event listeners with an event. This will also add an event to all
+ * parents (for `.observeDeep` handlers).
+ * @private
+ *
+ * @template EventType
+ * @param {AbstractType<EventType>} type
+ * @param {Transaction} transaction
+ * @param {EventType} event
+ */
+export const callTypeObservers = (type, transaction, event) => {
+  const changedType = type
+  const changedParentTypes = transaction.changedParentTypes
+  while (true) {
+    // @ts-ignore
+    map.setIfUndefined(changedParentTypes, type, () => []).push(event)
+    if (type._item === null) {
+      break
+    }
+    type = type._item.parent
+  }
+  callEventHandlerListeners(changedType._eH, event, transaction)
+}
+
+/**
+ * @template EventType
+ * Abstract Yjs Type class
+ */
+export class AbstractType {
+  constructor () {
+    /**
+     * @type {Item|null}
+     */
+    this._item = null
+    /**
+     * @private
+     * @type {Map<string,Item>}
+     */
+    this._map = new Map()
+    /**
+     * @private
+     * @type {Item|null}
+     */
+    this._start = null
+    /**
+     * @private
+     * @type {Doc|null}
+     */
+    this.doc = null
+    this._length = 0
+    /**
+     * Event handlers
+     * @type {EventHandler<EventType,Transaction>}
+     */
+    this._eH = createEventHandler()
+    /**
+     * Deep event handlers
+     * @type {EventHandler<Array<YEvent>,Transaction>}
+     */
+    this._dEH = createEventHandler()
+  }
+
+  /**
+   * Integrate this type into the Yjs instance.
+   *
+   * * Save this struct in the os
+   * * This type is sent to other client
+   * * Observer functions are fired
+   *
+   * @param {Doc} y The Yjs instance
+   * @param {Item|null} item
+   * @private
+   */
+  _integrate (y, item) {
+    this.doc = y
+    this._item = item
+  }
+
+  /**
+   * @return {AbstractType<EventType>}
+   * @private
+   */
+  _copy () {
+    throw error.methodUnimplemented()
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   * @private
+   */
+  _write (encoder) { }
+
+  /**
+   * The first non-deleted item
+   */
+  get _first () {
+    let n = this._start
+    while (n !== null && n.deleted) {
+      n = n.right
+    }
+    return n
+  }
+
+  /**
+   * Creates YEvent and calls all type observers.
+   * Must be implemented by each type.
+   *
+   * @param {Transaction} transaction
+   * @param {Set<null|string>} parentSubs Keys changed on this type. `null` if list was modified.
+   *
+   * @private
+   */
+  _callObserver (transaction, parentSubs) { /* skip if no type is specified */ }
+
+  /**
+   * Observe all events that are created on this type.
+   *
+   * @param {function(EventType, Transaction):void} f Observer function
+   */
+  observe (f) {
+    addEventHandlerListener(this._eH, f)
+  }
+
+  /**
+   * Observe all events that are created by this type and its children.
+   *
+   * @param {function(Array<YEvent>,Transaction):void} f Observer function
+   */
+  observeDeep (f) {
+    addEventHandlerListener(this._dEH, f)
+  }
+
+  /**
+   * Unregister an observer function.
+   *
+   * @param {function(EventType,Transaction):void} f Observer function
+   */
+  unobserve (f) {
+    removeEventHandlerListener(this._eH, f)
+  }
+
+  /**
+   * Unregister an observer function.
+   *
+   * @param {function(Array<YEvent>,Transaction):void} f Observer function
+   */
+  unobserveDeep (f) {
+    removeEventHandlerListener(this._dEH, f)
+  }
+
+  /**
+   * @abstract
+   * @return {any}
+   */
+  toJSON () {}
+}
+
+/**
+ * @param {AbstractType<any>} type
+ * @return {Array<any>}
+ *
+ * @private
+ * @function
+ */
+export const typeListToArray = type => {
+  const cs = []
+  let n = type._start
+  while (n !== null) {
+    if (n.countable && !n.deleted) {
+      const c = n.content.getContent()
+      for (let i = 0; i < c.length; i++) {
+        cs.push(c[i])
+      }
+    }
+    n = n.right
+  }
+  return cs
+}
+
+/**
+ * @param {AbstractType<any>} type
+ * @param {Snapshot} snapshot
+ * @return {Array<any>}
+ *
+ * @private
+ * @function
+ */
+export const typeListToArraySnapshot = (type, snapshot) => {
+  const cs = []
+  let n = type._start
+  while (n !== null) {
+    if (n.countable && isVisible(n, snapshot)) {
+      const c = n.content.getContent()
+      for (let i = 0; i < c.length; i++) {
+        cs.push(c[i])
+      }
+    }
+    n = n.right
+  }
+  return cs
+}
+
+/**
+ * Executes a provided function on once on overy element of this YArray.
+ *
+ * @param {AbstractType<any>} type
+ * @param {function(any,number,any):void} f A function to execute on every element of this YArray.
+ *
+ * @private
+ * @function
+ */
+export const typeListForEach = (type, f) => {
+  let index = 0
+  let n = type._start
+  while (n !== null) {
+    if (n.countable && !n.deleted) {
+      const c = n.content.getContent()
+      for (let i = 0; i < c.length; i++) {
+        f(c[i], index++, type)
+      }
+    }
+    n = n.right
+  }
+}
+
+/**
+ * @template C,R
+ * @param {AbstractType<any>} type
+ * @param {function(C,number,AbstractType<any>):R} f
+ * @return {Array<R>}
+ *
+ * @private
+ * @function
+ */
+export const typeListMap = (type, f) => {
+  /**
+   * @type {Array<any>}
+   */
+  const result = []
+  typeListForEach(type, (c, i) => {
+    result.push(f(c, i, type))
+  })
+  return result
+}
+
+/**
+ * @param {AbstractType<any>} type
+ * @return {IterableIterator<any>}
+ *
+ * @private
+ * @function
+ */
+export const typeListCreateIterator = type => {
+  let n = type._start
+  /**
+   * @type {Array<any>|null}
+   */
+  let currentContent = null
+  let currentContentIndex = 0
+  return {
+    [Symbol.iterator] () {
+      return this
+    },
+    next: () => {
+      // find some content
+      if (currentContent === null) {
+        while (n !== null && n.deleted) {
+          n = n.right
+        }
+        // check if we reached the end, no need to check currentContent, because it does not exist
+        if (n === null) {
+          return {
+            done: true,
+            value: undefined
+          }
+        }
+        // we found n, so we can set currentContent
+        currentContent = n.content.getContent()
+        currentContentIndex = 0
+        n = n.right // we used the content of n, now iterate to next
+      }
+      const value = currentContent[currentContentIndex++]
+      // check if we need to empty currentContent
+      if (currentContent.length <= currentContentIndex) {
+        currentContent = null
+      }
+      return {
+        done: false,
+        value
+      }
+    }
+  }
+}
+
+/**
+ * Executes a provided function on once on overy element of this YArray.
+ * Operates on a snapshotted state of the document.
+ *
+ * @param {AbstractType<any>} type
+ * @param {function(any,number,AbstractType<any>):void} f A function to execute on every element of this YArray.
+ * @param {Snapshot} snapshot
+ *
+ * @private
+ * @function
+ */
+export const typeListForEachSnapshot = (type, f, snapshot) => {
+  let index = 0
+  let n = type._start
+  while (n !== null) {
+    if (n.countable && isVisible(n, snapshot)) {
+      const c = n.content.getContent()
+      for (let i = 0; i < c.length; i++) {
+        f(c[i], index++, type)
+      }
+    }
+    n = n.right
+  }
+}
+
+/**
+ * @param {AbstractType<any>} type
+ * @param {number} index
+ * @return {any}
+ *
+ * @private
+ * @function
+ */
+export const typeListGet = (type, index) => {
+  for (let n = type._start; n !== null; n = n.right) {
+    if (!n.deleted && n.countable) {
+      if (index < n.length) {
+        return n.content.getContent()[index]
+      }
+      index -= n.length
+    }
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {Item?} referenceItem
+ * @param {Array<Object<string,any>|Array<any>|boolean|number|string|Uint8Array>} content
+ *
+ * @private
+ * @function
+ */
+export const typeListInsertGenericsAfter = (transaction, parent, referenceItem, content) => {
+  let left = referenceItem
+  const right = referenceItem === null ? parent._start : referenceItem.right
+  /**
+   * @type {Array<Object|Array<any>|number>}
+   */
+  let jsonContent = []
+  const packJsonContent = () => {
+    if (jsonContent.length > 0) {
+      left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentAny(jsonContent))
+      left.integrate(transaction)
+      jsonContent = []
+    }
+  }
+  content.forEach(c => {
+    switch (c.constructor) {
+      case Number:
+      case Object:
+      case Boolean:
+      case Array:
+      case String:
+        jsonContent.push(c)
+        break
+      default:
+        packJsonContent()
+        switch (c.constructor) {
+          case Uint8Array:
+          case ArrayBuffer:
+            left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentBinary(new Uint8Array(/** @type {Uint8Array} */ (c))))
+            left.integrate(transaction)
+            break
+          default:
+            if (c instanceof AbstractType) {
+              left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentType(c))
+              left.integrate(transaction)
+            } else {
+              throw new Error('Unexpected content type in insert operation')
+            }
+        }
+    }
+  })
+  packJsonContent()
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {number} index
+ * @param {Array<Object<string,any>|Array<any>|number|string|Uint8Array>} content
+ *
+ * @private
+ * @function
+ */
+export const typeListInsertGenerics = (transaction, parent, index, content) => {
+  if (index === 0) {
+    return typeListInsertGenericsAfter(transaction, parent, null, content)
+  }
+  let n = parent._start
+  for (; n !== null; n = n.right) {
+    if (!n.deleted && n.countable) {
+      if (index <= n.length) {
+        if (index < n.length) {
+          // insert in-between
+          getItemCleanStart(transaction, createID(n.id.client, n.id.clock + index))
+        }
+        break
+      }
+      index -= n.length
+    }
+  }
+  return typeListInsertGenericsAfter(transaction, parent, n, content)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {number} index
+ * @param {number} length
+ *
+ * @private
+ * @function
+ */
+export const typeListDelete = (transaction, parent, index, length) => {
+  if (length === 0) { return }
+  let n = parent._start
+  // compute the first item to be deleted
+  for (; n !== null && index > 0; n = n.right) {
+    if (!n.deleted && n.countable) {
+      if (index < n.length) {
+        getItemCleanStart(transaction, createID(n.id.client, n.id.clock + index))
+      }
+      index -= n.length
+    }
+  }
+  // delete all items until done
+  while (length > 0 && n !== null) {
+    if (!n.deleted) {
+      if (length < n.length) {
+        getItemCleanStart(transaction, createID(n.id.client, n.id.clock + length))
+      }
+      n.delete(transaction)
+      length -= n.length
+    }
+    n = n.right
+  }
+  if (length > 0) {
+    throw error.create('array length exceeded')
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {string} key
+ *
+ * @private
+ * @function
+ */
+export const typeMapDelete = (transaction, parent, key) => {
+  const c = parent._map.get(key)
+  if (c !== undefined) {
+    c.delete(transaction)
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {string} key
+ * @param {Object|number|Array<any>|string|Uint8Array|AbstractType<any>} value
+ *
+ * @private
+ * @function
+ */
+export const typeMapSet = (transaction, parent, key, value) => {
+  const left = parent._map.get(key) || null
+  let content
+  if (value == null) {
+    content = new ContentAny([value])
+  } else {
+    switch (value.constructor) {
+      case Number:
+      case Object:
+      case Boolean:
+      case Array:
+      case String:
+        content = new ContentAny([value])
+        break
+      case Uint8Array:
+        content = new ContentBinary(/** @type {Uint8Array} */ (value))
+        break
+      default:
+        if (value instanceof AbstractType) {
+          content = new ContentType(value)
+        } else {
+          throw new Error('Unexpected content type')
+        }
+    }
+  }
+  new Item(nextID(transaction), left, left === null ? null : left.lastId, null, null, parent, key, content).integrate(transaction)
+}
+
+/**
+ * @param {AbstractType<any>} parent
+ * @param {string} key
+ * @return {Object<string,any>|number|Array<any>|string|Uint8Array|AbstractType<any>|undefined}
+ *
+ * @private
+ * @function
+ */
+export const typeMapGet = (parent, key) => {
+  const val = parent._map.get(key)
+  return val !== undefined && !val.deleted ? val.content.getContent()[val.length - 1] : undefined
+}
+
+/**
+ * @param {AbstractType<any>} parent
+ * @return {Object<string,Object<string,any>|number|Array<any>|string|Uint8Array|AbstractType<any>|undefined>}
+ *
+ * @private
+ * @function
+ */
+export const typeMapGetAll = (parent) => {
+  /**
+   * @type {Object<string,any>}
+   */
+  const res = {}
+  for (const [key, value] of parent._map) {
+    if (!value.deleted) {
+      res[key] = value.content.getContent()[value.length - 1]
+    }
+  }
+  return res
+}
+
+/**
+ * @param {AbstractType<any>} parent
+ * @param {string} key
+ * @return {boolean}
+ *
+ * @private
+ * @function
+ */
+export const typeMapHas = (parent, key) => {
+  const val = parent._map.get(key)
+  return val !== undefined && !val.deleted
+}
+
+/**
+ * @param {AbstractType<any>} parent
+ * @param {string} key
+ * @param {Snapshot} snapshot
+ * @return {Object<string,any>|number|Array<any>|string|Uint8Array|AbstractType<any>|undefined}
+ *
+ * @private
+ * @function
+ */
+export const typeMapGetSnapshot = (parent, key, snapshot) => {
+  let v = parent._map.get(key) || null
+  while (v !== null && (!snapshot.sv.has(v.id.client) || v.id.clock >= (snapshot.sv.get(v.id.client) || 0))) {
+    v = v.left
+  }
+  return v !== null && isVisible(v, snapshot) ? v.content.getContent()[v.length - 1] : undefined
+}
+
+/**
+ * @param {Map<string,Item>} map
+ * @return {IterableIterator<Array<any>>}
+ *
+ * @private
+ * @function
+ */
+export const createMapIterator = map => iterator.iteratorFilter(map.entries(), /** @param {any} entry */ entry => !entry[1].deleted)

src/types/YArray.js

@@ -0,0 +1,216 @@
+/**
+ * @module YArray
+ */
+
+import {
+  YEvent,
+  AbstractType,
+  typeListGet,
+  typeListToArray,
+  typeListForEach,
+  typeListCreateIterator,
+  typeListInsertGenerics,
+  typeListDelete,
+  typeListMap,
+  YArrayRefID,
+  callTypeObservers,
+  transact,
+  Doc, Transaction, Item // eslint-disable-line
+} from '../internals.js'
+
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+import * as encoding from 'lib0/encoding.js'
+
+/**
+ * Event that describes the changes on a YArray
+ * @template T
+ */
+export class YArrayEvent extends YEvent {
+  /**
+   * @param {YArray<T>} yarray The changed type
+   * @param {Transaction} transaction The transaction object
+   */
+  constructor (yarray, transaction) {
+    super(yarray, transaction)
+    this._transaction = transaction
+  }
+}
+
+/**
+ * A shared Array implementation.
+ * @template T
+ * @extends AbstractType<YArrayEvent<T>>
+ * @implements {IterableIterator<T>}
+ */
+export class YArray extends AbstractType {
+  constructor () {
+    super()
+    /**
+     * @type {Array<any>?}
+     * @private
+     */
+    this._prelimContent = []
+  }
+
+  /**
+   * Integrate this type into the Yjs instance.
+   *
+   * * Save this struct in the os
+   * * This type is sent to other client
+   * * Observer functions are fired
+   *
+   * @param {Doc} y The Yjs instance
+   * @param {Item} item
+   *
+   * @private
+   */
+  _integrate (y, item) {
+    super._integrate(y, item)
+    this.insert(0, /** @type {Array<any>} */ (this._prelimContent))
+    this._prelimContent = null
+  }
+
+  _copy () {
+    return new YArray()
+  }
+
+  get length () {
+    return this._prelimContent === null ? this._length : this._prelimContent.length
+  }
+
+  /**
+   * Creates YArrayEvent and calls observers.
+   *
+   * @param {Transaction} transaction
+   * @param {Set<null|string>} parentSubs Keys changed on this type. `null` if list was modified.
+   *
+   * @private
+   */
+  _callObserver (transaction, parentSubs) {
+    callTypeObservers(this, transaction, new YArrayEvent(this, transaction))
+  }
+
+  /**
+   * Inserts new content at an index.
+   *
+   * Important: This function expects an array of content. Not just a content
+   * object. The reason for this "weirdness" is that inserting several elements
+   * is very efficient when it is done as a single operation.
+   *
+   * @example
+   *  // Insert character 'a' at position 0
+   *  yarray.insert(0, ['a'])
+   *  // Insert numbers 1, 2 at position 1
+   *  yarray.insert(1, [1, 2])
+   *
+   * @param {number} index The index to insert content at.
+   * @param {Array<T>} content The array of content
+   */
+  insert (index, content) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeListInsertGenerics(transaction, this, index, content)
+      })
+    } else {
+      /** @type {Array<any>} */ (this._prelimContent).splice(index, 0, ...content)
+    }
+  }
+
+  /**
+   * Appends content to this YArray.
+   *
+   * @param {Array<T>} content Array of content to append.
+   */
+  push (content) {
+    this.insert(this.length, content)
+  }
+
+  /**
+   * Deletes elements starting from an index.
+   *
+   * @param {number} index Index at which to start deleting elements
+   * @param {number} length The number of elements to remove. Defaults to 1.
+   */
+  delete (index, length = 1) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeListDelete(transaction, this, index, length)
+      })
+    } else {
+      /** @type {Array<any>} */ (this._prelimContent).splice(index, length)
+    }
+  }
+
+  /**
+   * Returns the i-th element from a YArray.
+   *
+   * @param {number} index The index of the element to return from the YArray
+   * @return {T}
+   */
+  get (index) {
+    return typeListGet(this, index)
+  }
+
+  /**
+   * Transforms this YArray to a JavaScript Array.
+   *
+   * @return {Array<T>}
+   */
+  toArray () {
+    return typeListToArray(this)
+  }
+
+  /**
+   * Transforms this Shared Type to a JSON object.
+   *
+   * @return {Array<any>}
+   */
+  toJSON () {
+    return this.map(c => c instanceof AbstractType ? c.toJSON() : c)
+  }
+
+  /**
+   * Returns an Array with the result of calling a provided function on every
+   * element of this YArray.
+   *
+   * @template T,M
+   * @param {function(T,number,YArray<T>):M} f Function that produces an element of the new Array
+   * @return {Array<M>} A new array with each element being the result of the
+   *                 callback function
+   */
+  map (f) {
+    return typeListMap(this, /** @type {any} */ (f))
+  }
+
+  /**
+   * Executes a provided function on once on overy element of this YArray.
+   *
+   * @param {function(T,number,YArray<T>):void} f A function to execute on every element of this YArray.
+   */
+  forEach (f) {
+    typeListForEach(this, f)
+  }
+
+  /**
+   * @return {IterableIterator<T>}
+   */
+  [Symbol.iterator] () {
+    return typeListCreateIterator(this)
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   * @private
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YArrayRefID)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ *
+ * @private
+ * @function
+ */
+export const readYArray = decoder => new YArray()

src/types/YMap.js

@@ -0,0 +1,232 @@
+
+/**
+ * @module YMap
+ */
+
+import {
+  YEvent,
+  AbstractType,
+  typeMapDelete,
+  typeMapSet,
+  typeMapGet,
+  typeMapHas,
+  createMapIterator,
+  YMapRefID,
+  callTypeObservers,
+  transact,
+  Doc, Transaction, Item // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+import * as iterator from 'lib0/iterator.js'
+
+/**
+ * @template T
+ * Event that describes the changes on a YMap.
+ */
+export class YMapEvent extends YEvent {
+  /**
+   * @param {YMap<T>} ymap The YArray that changed.
+   * @param {Transaction} transaction
+   * @param {Set<any>} subs The keys that changed.
+   */
+  constructor (ymap, transaction, subs) {
+    super(ymap, transaction)
+    this.keysChanged = subs
+  }
+}
+
+/**
+ * @template T number|string|Object|Array|Uint8Array
+ * A shared Map implementation.
+ *
+ * @extends AbstractType<YMapEvent<T>>
+ * @implements {IterableIterator}
+ */
+export class YMap extends AbstractType {
+  constructor () {
+    super()
+    /**
+     * @type {Map<string,any>?}
+     * @private
+     */
+    this._prelimContent = new Map()
+  }
+
+  /**
+   * Integrate this type into the Yjs instance.
+   *
+   * * Save this struct in the os
+   * * This type is sent to other client
+   * * Observer functions are fired
+   *
+   * @param {Doc} y The Yjs instance
+   * @param {Item} item
+   *
+   * @private
+   */
+  _integrate (y, item) {
+    super._integrate(y, item)
+    for (const [key, value] of /** @type {Map<string, any>} */ (this._prelimContent)) {
+      this.set(key, value)
+    }
+    this._prelimContent = null
+  }
+
+  _copy () {
+    return new YMap()
+  }
+
+  /**
+   * Creates YMapEvent and calls observers.
+   *
+   * @param {Transaction} transaction
+   * @param {Set<null|string>} parentSubs Keys changed on this type. `null` if list was modified.
+   *
+   * @private
+   */
+  _callObserver (transaction, parentSubs) {
+    callTypeObservers(this, transaction, new YMapEvent(this, transaction, parentSubs))
+  }
+
+  /**
+   * Transforms this Shared Type to a JSON object.
+   *
+   * @return {Object<string,T>}
+   */
+  toJSON () {
+    /**
+     * @type {Object<string,T>}
+     */
+    const map = {}
+    for (const [key, item] of this._map) {
+      if (!item.deleted) {
+        const v = item.content.getContent()[item.length - 1]
+        map[key] = v instanceof AbstractType ? v.toJSON() : v
+      }
+    }
+    return map
+  }
+
+  /**
+   * Returns the keys for each element in the YMap Type.
+   *
+   * @return {IterableIterator<string>}
+   */
+  keys () {
+    return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => v[0])
+  }
+
+  /**
+   * Returns the keys for each element in the YMap Type.
+   *
+   * @return {IterableIterator<string>}
+   */
+  values () {
+    return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => v[1].content.getContent()[v[1].length - 1])
+  }
+
+  /**
+   * Returns an Iterator of [key, value] pairs
+   *
+   * @return {IterableIterator<any>}
+   */
+  entries () {
+    return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => [v[0], v[1].content.getContent()[v[1].length - 1]])
+  }
+
+  /**
+   * Executes a provided function on once on overy key-value pair.
+   *
+   * @param {function(T,string,YMap<T>):void} f A function to execute on every element of this YArray.
+   */
+  forEach (f) {
+    /**
+     * @type {Object<string,T>}
+     */
+    const map = {}
+    for (const [key, item] of this._map) {
+      if (!item.deleted) {
+        f(item.content.getContent()[item.length - 1], key, this)
+      }
+    }
+    return map
+  }
+
+  /**
+   * @return {IterableIterator<T>}
+   */
+  [Symbol.iterator] () {
+    return this.entries()
+  }
+
+  /**
+   * Remove a specified element from this YMap.
+   *
+   * @param {string} key The key of the element to remove.
+   */
+  delete (key) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeMapDelete(transaction, this, key)
+      })
+    } else {
+      /** @type {Map<string, any>} */ (this._prelimContent).delete(key)
+    }
+  }
+
+  /**
+   * Adds or updates an element with a specified key and value.
+   *
+   * @param {string} key The key of the element to add to this YMap
+   * @param {T} value The value of the element to add
+   */
+  set (key, value) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeMapSet(transaction, this, key, value)
+      })
+    } else {
+      /** @type {Map<string, any>} */ (this._prelimContent).set(key, value)
+    }
+    return value
+  }
+
+  /**
+   * Returns a specified element from this YMap.
+   *
+   * @param {string} key
+   * @return {T|undefined}
+   */
+  get (key) {
+    return /** @type {any} */ (typeMapGet(this, key))
+  }
+
+  /**
+   * Returns a boolean indicating whether the specified key exists or not.
+   *
+   * @param {string} key The key to test.
+   * @return {boolean}
+   */
+  has (key) {
+    return typeMapHas(this, key)
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   *
+   * @private
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YMapRefID)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ *
+ * @private
+ * @function
+ */
+export const readYMap = decoder => new YMap()

src/types/YText.js

@@ -0,0 +1,944 @@
+
+/**
+ * @module YText
+ */
+
+import {
+  YEvent,
+  AbstractType,
+  nextID,
+  createID,
+  getItemCleanStart,
+  isVisible,
+  YTextRefID,
+  callTypeObservers,
+  transact,
+  ContentEmbed,
+  ContentFormat,
+  ContentString,
+  splitSnapshotAffectedStructs,
+  ID, Doc, Item, Snapshot, Transaction // eslint-disable-line
+} from '../internals.js'
+
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+import * as encoding from 'lib0/encoding.js'
+import * as object from 'lib0/object.js'
+
+/**
+ * @param {any} a
+ * @param {any} b
+ * @return {boolean}
+ */
+const equalAttrs = (a, b) => a === b || (typeof a === 'object' && typeof b === 'object' && a && b && object.equalFlat(a, b))
+
+export class ItemListPosition {
+  /**
+   * @param {Item|null} left
+   * @param {Item|null} right
+   */
+  constructor (left, right) {
+    this.left = left
+    this.right = right
+  }
+}
+
+export class ItemTextListPosition extends ItemListPosition {
+  /**
+   * @param {Item|null} left
+   * @param {Item|null} right
+   * @param {Map<string,any>} currentAttributes
+   */
+  constructor (left, right, currentAttributes) {
+    super(left, right)
+    this.currentAttributes = currentAttributes
+  }
+}
+
+export class ItemInsertionResult extends ItemListPosition {
+  /**
+   * @param {Item|null} left
+   * @param {Item|null} right
+   * @param {Map<string,any>} negatedAttributes
+   */
+  constructor (left, right, negatedAttributes) {
+    super(left, right)
+    this.negatedAttributes = negatedAttributes
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {Map<string,any>} currentAttributes
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {number} count
+ * @return {ItemTextListPosition}
+ *
+ * @private
+ * @function
+ */
+const findNextPosition = (transaction, currentAttributes, left, right, count) => {
+  while (right !== null && count > 0) {
+    switch (right.content.constructor) {
+      case ContentEmbed:
+      case ContentString:
+        if (!right.deleted) {
+          if (count < right.length) {
+            // split right
+            getItemCleanStart(transaction, createID(right.id.client, right.id.clock + count))
+          }
+          count -= right.length
+        }
+        break
+      case ContentFormat:
+        if (!right.deleted) {
+          updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (right.content))
+        }
+        break
+    }
+    left = right
+    right = right.right
+  }
+  return new ItemTextListPosition(left, right, currentAttributes)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {number} index
+ * @return {ItemTextListPosition}
+ *
+ * @private
+ * @function
+ */
+const findPosition = (transaction, parent, index) => {
+  const currentAttributes = new Map()
+  const right = parent._start
+  return findNextPosition(transaction, currentAttributes, null, right, index)
+}
+
+/**
+ * Negate applied formats
+ *
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} negatedAttributes
+ * @return {ItemListPosition}
+ *
+ * @private
+ * @function
+ */
+const insertNegatedAttributes = (transaction, parent, left, right, negatedAttributes) => {
+  // check if we really need to remove attributes
+  while (
+    right !== null && (
+      right.deleted === true || (
+        right.content.constructor === ContentFormat &&
+        equalAttrs(negatedAttributes.get(/** @type {ContentFormat} */ (right.content).key), /** @type {ContentFormat} */ (right.content).value)
+      )
+    )
+  ) {
+    if (!right.deleted) {
+      negatedAttributes.delete(/** @type {ContentFormat} */ (right.content).key)
+    }
+    left = right
+    right = right.right
+  }
+  for (const [key, val] of negatedAttributes) {
+    left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentFormat(key, val))
+    left.integrate(transaction)
+  }
+  return { left, right }
+}
+
+/**
+ * @param {Map<string,any>} currentAttributes
+ * @param {ContentFormat} format
+ *
+ * @private
+ * @function
+ */
+const updateCurrentAttributes = (currentAttributes, format) => {
+  const { key, value } = format
+  if (value === null) {
+    currentAttributes.delete(key)
+  } else {
+    currentAttributes.set(key, value)
+  }
+}
+
+/**
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} currentAttributes
+ * @param {Object<string,any>} attributes
+ * @return {ItemListPosition}
+ *
+ * @private
+ * @function
+ */
+const minimizeAttributeChanges = (left, right, currentAttributes, attributes) => {
+  // go right while attributes[right.key] === right.value (or right is deleted)
+  while (true) {
+    if (right === null) {
+      break
+    } else if (right.deleted) {
+      // continue
+    } else if (right.content.constructor === ContentFormat && equalAttrs(attributes[(/** @type {ContentFormat} */ (right.content)).key] || null, /** @type {ContentFormat} */ (right.content).value)) {
+      // found a format, update currentAttributes and continue
+      updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (right.content))
+    } else {
+      break
+    }
+    left = right
+    right = right.right
+  }
+  return new ItemListPosition(left, right)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} currentAttributes
+ * @param {Object<string,any>} attributes
+ * @return {ItemInsertionResult}
+ *
+ * @private
+ * @function
+ **/
+const insertAttributes = (transaction, parent, left, right, currentAttributes, attributes) => {
+  const negatedAttributes = new Map()
+  // insert format-start items
+  for (const key in attributes) {
+    const val = attributes[key]
+    const currentVal = currentAttributes.get(key) || null
+    if (!equalAttrs(currentVal, val)) {
+      // save negated attribute (set null if currentVal undefined)
+      negatedAttributes.set(key, currentVal)
+      left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentFormat(key, val))
+      left.integrate(transaction)
+    }
+  }
+  return new ItemInsertionResult(left, right, negatedAttributes)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} currentAttributes
+ * @param {string|object} text
+ * @param {Object<string,any>} attributes
+ * @return {ItemListPosition}
+ *
+ * @private
+ * @function
+ **/
+const insertText = (transaction, parent, left, right, currentAttributes, text, attributes) => {
+  for (const [key] of currentAttributes) {
+    if (attributes[key] === undefined) {
+      attributes[key] = null
+    }
+  }
+  const minPos = minimizeAttributeChanges(left, right, currentAttributes, attributes)
+  const insertPos = insertAttributes(transaction, parent, minPos.left, minPos.right, currentAttributes, attributes)
+  left = insertPos.left
+  right = insertPos.right
+  // insert content
+  const content = text.constructor === String ? new ContentString(text) : new ContentEmbed(text)
+  left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, content)
+  left.integrate(transaction)
+  return insertNegatedAttributes(transaction, parent, left, insertPos.right, insertPos.negatedAttributes)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {AbstractType<any>} parent
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} currentAttributes
+ * @param {number} length
+ * @param {Object<string,any>} attributes
+ * @return {ItemListPosition}
+ *
+ * @private
+ * @function
+ */
+const formatText = (transaction, parent, left, right, currentAttributes, length, attributes) => {
+  const minPos = minimizeAttributeChanges(left, right, currentAttributes, attributes)
+  const insertPos = insertAttributes(transaction, parent, minPos.left, minPos.right, currentAttributes, attributes)
+  const negatedAttributes = insertPos.negatedAttributes
+  left = insertPos.left
+  right = insertPos.right
+  // iterate until first non-format or null is found
+  // delete all formats with attributes[format.key] != null
+  while (length > 0 && right !== null) {
+    if (!right.deleted) {
+      switch (right.content.constructor) {
+        case ContentFormat: {
+          const { key, value } = /** @type {ContentFormat} */ (right.content)
+          const attr = attributes[key]
+          if (attr !== undefined) {
+            if (equalAttrs(attr, value)) {
+              negatedAttributes.delete(key)
+            } else {
+              negatedAttributes.set(key, value)
+            }
+            right.delete(transaction)
+          }
+          updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (right.content))
+          break
+        }
+        case ContentEmbed:
+        case ContentString:
+          if (length < right.length) {
+            getItemCleanStart(transaction, createID(right.id.client, right.id.clock + length))
+          }
+          length -= right.length
+          break
+      }
+    }
+    left = right
+    right = right.right
+  }
+  // Quill just assumes that the editor starts with a newline and that it always
+  // ends with a newline. We only insert that newline when a new newline is
+  // inserted - i.e when length is bigger than type.length
+  if (length > 0) {
+    let newlines = ''
+    for (; length > 0; length--) {
+      newlines += '\n'
+    }
+    left = new Item(nextID(transaction), left, left === null ? null : left.lastId, right, right === null ? null : right.id, parent, null, new ContentString(newlines))
+    left.integrate(transaction)
+  }
+  return insertNegatedAttributes(transaction, parent, left, right, negatedAttributes)
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {Item|null} left
+ * @param {Item|null} right
+ * @param {Map<string,any>} currentAttributes
+ * @param {number} length
+ * @return {ItemListPosition}
+ *
+ * @private
+ * @function
+ */
+const deleteText = (transaction, left, right, currentAttributes, length) => {
+  while (length > 0 && right !== null) {
+    if (right.deleted === false) {
+      switch (right.content.constructor) {
+        case ContentFormat:
+          updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (right.content))
+          break
+        case ContentEmbed:
+        case ContentString:
+          if (length < right.length) {
+            getItemCleanStart(transaction, createID(right.id.client, right.id.clock + length))
+          }
+          length -= right.length
+          right.delete(transaction)
+          break
+      }
+    }
+    left = right
+    right = right.right
+  }
+  return { left, right }
+}
+
+/**
+ * The Quill Delta format represents changes on a text document with
+ * formatting information. For mor information visit {@link https://quilljs.com/docs/delta/|Quill Delta}
+ *
+ * @example
+ *   {
+ *     ops: [
+ *       { insert: 'Gandalf', attributes: { bold: true } },
+ *       { insert: ' the ' },
+ *       { insert: 'Grey', attributes: { color: '#cccccc' } }
+ *     ]
+ *   }
+ *
+ */
+
+/**
+  * Attributes that can be assigned to a selection of text.
+  *
+  * @example
+  *   {
+  *     bold: true,
+  *     font-size: '40px'
+  *   }
+  *
+  * @typedef {Object} TextAttributes
+  */
+
+/**
+ * @typedef {Object} DeltaItem
+ * @property {number|undefined} DeltaItem.delete
+ * @property {number|undefined} DeltaItem.retain
+ * @property {string|undefined} DeltaItem.string
+ * @property {Object<string,any>} DeltaItem.attributes
+ */
+
+/**
+ * Event that describes the changes on a YText type.
+ */
+export class YTextEvent extends YEvent {
+  /**
+   * @param {YText} ytext
+   * @param {Transaction} transaction
+   */
+  constructor (ytext, transaction) {
+    super(ytext, transaction)
+    /**
+     * @private
+     * @type {Array<DeltaItem>|null}
+     */
+    this._delta = null
+  }
+
+  /**
+   * Compute the changes in the delta format.
+   * A {@link https://quilljs.com/docs/delta/|Quill Delta}) that represents the changes on the document.
+   *
+   * @type {Array<DeltaItem>}
+   *
+   * @public
+   */
+  get delta () {
+    if (this._delta === null) {
+      const y = /** @type {Doc} */ (this.target.doc)
+      this._delta = []
+      transact(y, transaction => {
+        const delta = /** @type {Array<DeltaItem>} */ (this._delta)
+        const currentAttributes = new Map() // saves all current attributes for insert
+        const oldAttributes = new Map()
+        let item = this.target._start
+        /**
+         * @type {string?}
+         */
+        let action = null
+        /**
+         * @type {Object<string,any>}
+         */
+        const attributes = {} // counts added or removed new attributes for retain
+        /**
+         * @type {string|object}
+         */
+        let insert = ''
+        let retain = 0
+        let deleteLen = 0
+        const addOp = () => {
+          if (action !== null) {
+            /**
+             * @type {any}
+             */
+            let op
+            switch (action) {
+              case 'delete':
+                op = { delete: deleteLen }
+                deleteLen = 0
+                break
+              case 'insert':
+                op = { insert }
+                if (currentAttributes.size > 0) {
+                  op.attributes = {}
+                  for (const [key, value] of currentAttributes) {
+                    if (value !== null) {
+                      op.attributes[key] = value
+                    }
+                  }
+                }
+                insert = ''
+                break
+              case 'retain':
+                op = { retain }
+                if (Object.keys(attributes).length > 0) {
+                  op.attributes = {}
+                  for (const key in attributes) {
+                    op.attributes[key] = attributes[key]
+                  }
+                }
+                retain = 0
+                break
+            }
+            delta.push(op)
+            action = null
+          }
+        }
+        while (item !== null) {
+          switch (item.content.constructor) {
+            case ContentEmbed:
+              if (this.adds(item)) {
+                if (!this.deletes(item)) {
+                  addOp()
+                  action = 'insert'
+                  insert = /** @type {ContentEmbed} */ (item.content).embed
+                  addOp()
+                }
+              } else if (this.deletes(item)) {
+                if (action !== 'delete') {
+                  addOp()
+                  action = 'delete'
+                }
+                deleteLen += 1
+              } else if (!item.deleted) {
+                if (action !== 'retain') {
+                  addOp()
+                  action = 'retain'
+                }
+                retain += 1
+              }
+              break
+            case ContentString:
+              if (this.adds(item)) {
+                if (!this.deletes(item)) {
+                  if (action !== 'insert') {
+                    addOp()
+                    action = 'insert'
+                  }
+                  insert += /** @type {ContentString} */ (item.content).str
+                }
+              } else if (this.deletes(item)) {
+                if (action !== 'delete') {
+                  addOp()
+                  action = 'delete'
+                }
+                deleteLen += item.length
+              } else if (!item.deleted) {
+                if (action !== 'retain') {
+                  addOp()
+                  action = 'retain'
+                }
+                retain += item.length
+              }
+              break
+            case ContentFormat: {
+              const { key, value } = /** @type {ContentFormat} */ (item.content)
+              if (this.adds(item)) {
+                if (!this.deletes(item)) {
+                  const curVal = currentAttributes.get(key) || null
+                  if (!equalAttrs(curVal, value)) {
+                    if (action === 'retain') {
+                      addOp()
+                    }
+                    if (equalAttrs(value, (oldAttributes.get(key) || null))) {
+                      delete attributes[key]
+                    } else {
+                      attributes[key] = value
+                    }
+                  } else {
+                    item.delete(transaction)
+                  }
+                }
+              } else if (this.deletes(item)) {
+                oldAttributes.set(key, value)
+                const curVal = currentAttributes.get(key) || null
+                if (!equalAttrs(curVal, value)) {
+                  if (action === 'retain') {
+                    addOp()
+                  }
+                  attributes[key] = curVal
+                }
+              } else if (!item.deleted) {
+                oldAttributes.set(key, value)
+                const attr = attributes[key]
+                if (attr !== undefined) {
+                  if (!equalAttrs(attr, value)) {
+                    if (action === 'retain') {
+                      addOp()
+                    }
+                    if (value === null) {
+                      attributes[key] = value
+                    } else {
+                      delete attributes[key]
+                    }
+                  } else {
+                    item.delete(transaction)
+                  }
+                }
+              }
+              if (!item.deleted) {
+                if (action === 'insert') {
+                  addOp()
+                }
+                updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (item.content))
+              }
+              break
+            }
+          }
+          item = item.right
+        }
+        addOp()
+        while (delta.length > 0) {
+          const lastOp = delta[delta.length - 1]
+          if (lastOp.retain !== undefined && lastOp.attributes === undefined) {
+            // retain delta's if they don't assign attributes
+            delta.pop()
+          } else {
+            break
+          }
+        }
+      })
+    }
+    return this._delta
+  }
+}
+
+/**
+ * Type that represents text with formatting information.
+ *
+ * This type replaces y-richtext as this implementation is able to handle
+ * block formats (format information on a paragraph), embeds (complex elements
+ * like pictures and videos), and text formats (**bold**, *italic*).
+ *
+ * @extends AbstractType<YTextEvent>
+ */
+export class YText extends AbstractType {
+  /**
+   * @param {String} [string] The initial value of the YText.
+   */
+  constructor (string) {
+    super()
+    /**
+     * Array of pending operations on this type
+     * @type {Array<function():void>?}
+     * @private
+     */
+    this._pending = string !== undefined ? [() => this.insert(0, string)] : []
+  }
+
+  /**
+   * Number of characters of this text type.
+   *
+   * @type {number}
+   */
+  get length () {
+    return this._length
+  }
+
+  /**
+   * @param {Doc} y
+   * @param {Item} item
+   *
+   * @private
+   */
+  _integrate (y, item) {
+    super._integrate(y, item)
+    try {
+      /** @type {Array<function>} */ (this._pending).forEach(f => f())
+    } catch (e) {
+      console.error(e)
+    }
+    this._pending = null
+  }
+
+  _copy () {
+    return new YText()
+  }
+
+  /**
+   * Creates YTextEvent and calls observers.
+   *
+   * @param {Transaction} transaction
+   * @param {Set<null|string>} parentSubs Keys changed on this type. `null` if list was modified.
+   *
+   * @private
+   */
+  _callObserver (transaction, parentSubs) {
+    callTypeObservers(this, transaction, new YTextEvent(this, transaction))
+  }
+
+  /**
+   * Returns the unformatted string representation of this YText type.
+   *
+   * @public
+   */
+  toString () {
+    let str = ''
+    /**
+     * @type {Item|null}
+     */
+    let n = this._start
+    while (n !== null) {
+      if (!n.deleted && n.countable && n.content.constructor === ContentString) {
+        str += /** @type {ContentString} */ (n.content).str
+      }
+      n = n.right
+    }
+    return str
+  }
+
+  /**
+   * Returns the unformatted string representation of this YText type.
+   *
+   * @return {string}
+   * @public
+   */
+  toJSON () {
+    return this.toString()
+  }
+
+  /**
+   * Apply a {@link Delta} on this shared YText type.
+   *
+   * @param {any} delta The changes to apply on this element.
+   *
+   * @public
+   */
+  applyDelta (delta) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        /**
+         * @type {ItemListPosition}
+         */
+        let pos = new ItemListPosition(null, this._start)
+        const currentAttributes = new Map()
+        for (let i = 0; i < delta.length; i++) {
+          const op = delta[i]
+          if (op.insert !== undefined) {
+            // Quill assumes that the content starts with an empty paragraph.
+            // Yjs/Y.Text assumes that it starts empty. We always hide that
+            // there is a newline at the end of the content.
+            // If we omit this step, clients will see a different number of
+            // paragraphs, but nothing bad will happen.
+            const ins = (typeof op.insert === 'string' && i === delta.length - 1 && pos.right === null && op.insert.slice(-1) === '\n') ? op.insert.slice(0, -1) : op.insert
+            if (typeof ins !== 'string' || ins.length > 0) {
+              pos = insertText(transaction, this, pos.left, pos.right, currentAttributes, ins, op.attributes || {})
+            }
+          } else if (op.retain !== undefined) {
+            pos = formatText(transaction, this, pos.left, pos.right, currentAttributes, op.retain, op.attributes || {})
+          } else if (op.delete !== undefined) {
+            pos = deleteText(transaction, pos.left, pos.right, currentAttributes, op.delete)
+          }
+        }
+      })
+    } else {
+      /** @type {Array<function>} */ (this._pending).push(() => this.applyDelta(delta))
+    }
+  }
+
+  /**
+   * Returns the Delta representation of this YText type.
+   *
+   * @param {Snapshot} [snapshot]
+   * @param {Snapshot} [prevSnapshot]
+   * @param {function('removed' | 'added', ID):any} [computeYChange]
+   * @return {any} The Delta representation of this type.
+   *
+   * @public
+   */
+  toDelta (snapshot, prevSnapshot, computeYChange) {
+    /**
+     * @type{Array<any>}
+     */
+    const ops = []
+    const currentAttributes = new Map()
+    const doc = /** @type {Doc} */ (this.doc)
+    let str = ''
+    let n = this._start
+    function packStr () {
+      if (str.length > 0) {
+        // pack str with attributes to ops
+        /**
+         * @type {Object<string,any>}
+         */
+        const attributes = {}
+        let addAttributes = false
+        for (const [key, value] of currentAttributes) {
+          addAttributes = true
+          attributes[key] = value
+        }
+        /**
+         * @type {Object<string,any>}
+         */
+        const op = { insert: str }
+        if (addAttributes) {
+          op.attributes = attributes
+        }
+        ops.push(op)
+        str = ''
+      }
+    }
+    // snapshots are merged again after the transaction, so we need to keep the
+    // transalive until we are done
+    transact(doc, transaction => {
+      if (snapshot) {
+        splitSnapshotAffectedStructs(transaction, snapshot)
+      }
+      if (prevSnapshot) {
+        splitSnapshotAffectedStructs(transaction, prevSnapshot)
+      }
+      while (n !== null) {
+        if (isVisible(n, snapshot) || (prevSnapshot !== undefined && isVisible(n, prevSnapshot))) {
+          switch (n.content.constructor) {
+            case ContentString: {
+              const cur = currentAttributes.get('ychange')
+              if (snapshot !== undefined && !isVisible(n, snapshot)) {
+                if (cur === undefined || cur.user !== n.id.client || cur.state !== 'removed') {
+                  packStr()
+                  currentAttributes.set('ychange', computeYChange ? computeYChange('removed', n.id) : { type: 'removed' })
+                }
+              } else if (prevSnapshot !== undefined && !isVisible(n, prevSnapshot)) {
+                if (cur === undefined || cur.user !== n.id.client || cur.state !== 'added') {
+                  packStr()
+                  currentAttributes.set('ychange', computeYChange ? computeYChange('added', n.id) : { type: 'added' })
+                }
+              } else if (cur !== undefined) {
+                packStr()
+                currentAttributes.delete('ychange')
+              }
+              str += /** @type {ContentString} */ (n.content).str
+              break
+            }
+            case ContentEmbed:
+              packStr()
+              ops.push({
+                insert: /** @type {ContentEmbed} */ (n.content).embed
+              })
+              break
+            case ContentFormat:
+              if (isVisible(n, snapshot)) {
+                packStr()
+                updateCurrentAttributes(currentAttributes, /** @type {ContentFormat} */ (n.content))
+              }
+              break
+          }
+        }
+        n = n.right
+      }
+      packStr()
+    }, splitSnapshotAffectedStructs)
+    return ops
+  }
+
+  /**
+   * Insert text at a given index.
+   *
+   * @param {number} index The index at which to start inserting.
+   * @param {String} text The text to insert at the specified position.
+   * @param {TextAttributes} [attributes] Optionally define some formatting
+   *                                    information to apply on the inserted
+   *                                    Text.
+   * @public
+   */
+  insert (index, text, attributes) {
+    if (text.length <= 0) {
+      return
+    }
+    const y = this.doc
+    if (y !== null) {
+      transact(y, transaction => {
+        const { left, right, currentAttributes } = findPosition(transaction, this, index)
+        if (!attributes) {
+          attributes = {}
+          // @ts-ignore
+          currentAttributes.forEach((v, k) => { attributes[k] = v })
+        }
+        insertText(transaction, this, left, right, currentAttributes, text, attributes)
+      })
+    } else {
+      /** @type {Array<function>} */ (this._pending).push(() => this.insert(index, text, attributes))
+    }
+  }
+
+  /**
+   * Inserts an embed at a index.
+   *
+   * @param {number} index The index to insert the embed at.
+   * @param {Object} embed The Object that represents the embed.
+   * @param {TextAttributes} attributes Attribute information to apply on the
+   *                                    embed
+   *
+   * @public
+   */
+  insertEmbed (index, embed, attributes = {}) {
+    if (embed.constructor !== Object) {
+      throw new Error('Embed must be an Object')
+    }
+    const y = this.doc
+    if (y !== null) {
+      transact(y, transaction => {
+        const { left, right, currentAttributes } = findPosition(transaction, this, index)
+        insertText(transaction, this, left, right, currentAttributes, embed, attributes)
+      })
+    } else {
+      /** @type {Array<function>} */ (this._pending).push(() => this.insertEmbed(index, embed, attributes))
+    }
+  }
+
+  /**
+   * Deletes text starting from an index.
+   *
+   * @param {number} index Index at which to start deleting.
+   * @param {number} length The number of characters to remove. Defaults to 1.
+   *
+   * @public
+   */
+  delete (index, length) {
+    if (length === 0) {
+      return
+    }
+    const y = this.doc
+    if (y !== null) {
+      transact(y, transaction => {
+        const { left, right, currentAttributes } = findPosition(transaction, this, index)
+        deleteText(transaction, left, right, currentAttributes, length)
+      })
+    } else {
+      /** @type {Array<function>} */ (this._pending).push(() => this.delete(index, length))
+    }
+  }
+
+  /**
+   * Assigns properties to a range of text.
+   *
+   * @param {number} index The position where to start formatting.
+   * @param {number} length The amount of characters to assign properties to.
+   * @param {TextAttributes} attributes Attribute information to apply on the
+   *                                    text.
+   *
+   * @public
+   */
+  format (index, length, attributes) {
+    const y = this.doc
+    if (y !== null) {
+      transact(y, transaction => {
+        const { left, right, currentAttributes } = findPosition(transaction, this, index)
+        if (right === null) {
+          return
+        }
+        formatText(transaction, this, left, right, currentAttributes, length, attributes)
+      })
+    } else {
+      /** @type {Array<function>} */ (this._pending).push(() => this.format(index, length, attributes))
+    }
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   *
+   * @private
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YTextRefID)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {YText}
+ *
+ * @private
+ * @function
+ */
+export const readYText = decoder => new YText()

src/types/YXmlElement.js

@@ -0,0 +1,203 @@
+
+import {
+  YXmlFragment,
+  transact,
+  typeMapDelete,
+  typeMapSet,
+  typeMapGet,
+  typeMapGetAll,
+  typeListForEach,
+  YXmlElementRefID,
+  Snapshot, Doc, Item // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * An YXmlElement imitates the behavior of a
+ * {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}.
+ *
+ * * An YXmlElement has attributes (key value pairs)
+ * * An YXmlElement has childElements that must inherit from YXmlElement
+ */
+export class YXmlElement extends YXmlFragment {
+  constructor (nodeName = 'UNDEFINED') {
+    super()
+    this.nodeName = nodeName
+    /**
+     * @type {Map<string, any>|null}
+     * @private
+     */
+    this._prelimAttrs = new Map()
+  }
+
+  /**
+   * Integrate this type into the Yjs instance.
+   *
+   * * Save this struct in the os
+   * * This type is sent to other client
+   * * Observer functions are fired
+   *
+   * @param {Doc} y The Yjs instance
+   * @param {Item} item
+   * @private
+   */
+  _integrate (y, item) {
+    super._integrate(y, item)
+    ;(/** @type {Map<string, any>} */ (this._prelimAttrs)).forEach((value, key) => {
+      this.setAttribute(key, value)
+    })
+    this._prelimAttrs = null
+  }
+
+  /**
+   * Creates an Item with the same effect as this Item (without position effect)
+   *
+   * @return {YXmlElement}
+   * @private
+   */
+  _copy () {
+    return new YXmlElement(this.nodeName)
+  }
+
+  /**
+   * Returns the XML serialization of this YXmlElement.
+   * The attributes are ordered by attribute-name, so you can easily use this
+   * method to compare YXmlElements
+   *
+   * @return {string} The string representation of this type.
+   *
+   * @public
+   */
+  toString () {
+    const attrs = this.getAttributes()
+    const stringBuilder = []
+    const keys = []
+    for (const key in attrs) {
+      keys.push(key)
+    }
+    keys.sort()
+    const keysLen = keys.length
+    for (let i = 0; i < keysLen; i++) {
+      const key = keys[i]
+      stringBuilder.push(key + '="' + attrs[key] + '"')
+    }
+    const nodeName = this.nodeName.toLocaleLowerCase()
+    const attrsString = stringBuilder.length > 0 ? ' ' + stringBuilder.join(' ') : ''
+    return `<${nodeName}${attrsString}>${super.toString()}</${nodeName}>`
+  }
+
+  /**
+   * Removes an attribute from this YXmlElement.
+   *
+   * @param {String} attributeName The attribute name that is to be removed.
+   *
+   * @public
+   */
+  removeAttribute (attributeName) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeMapDelete(transaction, this, attributeName)
+      })
+    } else {
+      /** @type {Map<string,any>} */ (this._prelimAttrs).delete(attributeName)
+    }
+  }
+
+  /**
+   * Sets or updates an attribute.
+   *
+   * @param {String} attributeName The attribute name that is to be set.
+   * @param {String} attributeValue The attribute value that is to be set.
+   *
+   * @public
+   */
+  setAttribute (attributeName, attributeValue) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeMapSet(transaction, this, attributeName, attributeValue)
+      })
+    } else {
+      /** @type {Map<string, any>} */ (this._prelimAttrs).set(attributeName, attributeValue)
+    }
+  }
+
+  /**
+   * Returns an attribute value that belongs to the attribute name.
+   *
+   * @param {String} attributeName The attribute name that identifies the
+   *                               queried value.
+   * @return {String} The queried attribute value.
+   *
+   * @public
+   */
+  getAttribute (attributeName) {
+    return /** @type {any} */ (typeMapGet(this, attributeName))
+  }
+
+  /**
+   * Returns all attribute name/value pairs in a JSON Object.
+   *
+   * @param {Snapshot} [snapshot]
+   * @return {Object<string, any>} A JSON Object that describes the attributes.
+   *
+   * @public
+   */
+  getAttributes (snapshot) {
+    return typeMapGetAll(this)
+  }
+
+  /**
+   * Creates a Dom Element that mirrors this YXmlElement.
+   *
+   * @param {Document} [_document=document] The document object (you must define
+   *                                        this when calling this method in
+   *                                        nodejs)
+   * @param {Object<string, any>} [hooks={}] Optional property to customize how hooks
+   *                                             are presented in the DOM
+   * @param {any} [binding] You should not set this property. This is
+   *                               used if DomBinding wants to create a
+   *                               association to the created DOM type.
+   * @return {Node} The {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}
+   *
+   * @public
+   */
+  toDOM (_document = document, hooks = {}, binding) {
+    const dom = _document.createElement(this.nodeName)
+    const attrs = this.getAttributes()
+    for (const key in attrs) {
+      dom.setAttribute(key, attrs[key])
+    }
+    typeListForEach(this, yxml => {
+      dom.appendChild(yxml.toDOM(_document, hooks, binding))
+    })
+    if (binding !== undefined) {
+      binding._createAssociation(dom, this)
+    }
+    return dom
+  }
+
+  /**
+   * Transform the properties of this type to binary and write it to an
+   * BinaryEncoder.
+   *
+   * This is called when this Item is sent to a remote peer.
+   *
+   * @private
+   * @param {encoding.Encoder} encoder The encoder to write data to.
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YXmlElementRefID)
+    encoding.writeVarString(encoder, this.nodeName)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {YXmlElement}
+ *
+ * @private
+ * @function
+ */
+export const readYXmlElement = decoder => new YXmlElement(decoding.readVarString(decoder))

src/types/YXmlEvent.js

@@ -0,0 +1,39 @@
+
+import {
+  YEvent,
+  YXmlElement, YXmlFragment, Transaction // eslint-disable-line
+} from '../internals.js'
+
+/**
+ * An Event that describes changes on a YXml Element or Yxml Fragment
+ */
+export class YXmlEvent extends YEvent {
+  /**
+   * @param {YXmlElement|YXmlFragment} target The target on which the event is created.
+   * @param {Set<string|null>} subs The set of changed attributes. `null` is included if the
+   *                   child list changed.
+   * @param {Transaction} transaction The transaction instance with wich the
+   *                                  change was created.
+   */
+  constructor (target, subs, transaction) {
+    super(target, transaction)
+    /**
+     * Whether the children changed.
+     * @type {Boolean}
+     * @private
+     */
+    this.childListChanged = false
+    /**
+     * Set of all changed attributes.
+     * @type {Set<string|null>}
+     */
+    this.attributesChanged = new Set()
+    subs.forEach((sub) => {
+      if (sub === null) {
+        this.childListChanged = true
+      } else {
+        this.attributesChanged.add(sub)
+      }
+    })
+  }
+}

src/types/YXmlFragment.js

@@ -0,0 +1,346 @@
+/**
+ * @module YXml
+ */
+
+import {
+  YXmlEvent,
+  YXmlElement,
+  AbstractType,
+  typeListMap,
+  typeListForEach,
+  typeListInsertGenerics,
+  typeListDelete,
+  typeListToArray,
+  YXmlFragmentRefID,
+  callTypeObservers,
+  transact,
+  Doc, ContentType, Transaction, Item, YXmlText, YXmlHook, Snapshot // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+
+/**
+ * Define the elements to which a set of CSS queries apply.
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors|CSS_Selectors}
+ *
+ * @example
+ *   query = '.classSelector'
+ *   query = 'nodeSelector'
+ *   query = '#idSelector'
+ *
+ * @typedef {string} CSS_Selector
+ */
+
+/**
+ * Dom filter function.
+ *
+ * @callback domFilter
+ * @param {string} nodeName The nodeName of the element
+ * @param {Map} attributes The map of attributes.
+ * @return {boolean} Whether to include the Dom node in the YXmlElement.
+ */
+
+/**
+ * Represents a subset of the nodes of a YXmlElement / YXmlFragment and a
+ * position within them.
+ *
+ * Can be created with {@link YXmlFragment#createTreeWalker}
+ *
+ * @public
+ * @implements {IterableIterator}
+ */
+export class YXmlTreeWalker {
+  /**
+   * @param {YXmlFragment | YXmlElement} root
+   * @param {function(AbstractType<any>):boolean} [f]
+   */
+  constructor (root, f = () => true) {
+    this._filter = f
+    this._root = root
+    /**
+     * @type {Item}
+     */
+    this._currentNode = /** @type {Item} */ (root._start)
+    this._firstCall = true
+  }
+
+  [Symbol.iterator] () {
+    return this
+  }
+
+  /**
+   * Get the next node.
+   *
+   * @return {IteratorResult<YXmlElement|YXmlText|YXmlHook>} The next node.
+   *
+   * @public
+   */
+  next () {
+    /**
+     * @type {Item|null}
+     */
+    let n = this._currentNode
+    let type = /** @type {ContentType} */ (n.content).type
+    if (n !== null && (!this._firstCall || n.deleted || !this._filter(type))) { // if first call, we check if we can use the first item
+      do {
+        type = /** @type {ContentType} */ (n.content).type
+        if (!n.deleted && (type.constructor === YXmlElement || type.constructor === YXmlFragment) && type._start !== null) {
+          // walk down in the tree
+          n = type._start
+        } else {
+          // walk right or up in the tree
+          while (n !== null) {
+            if (n.right !== null) {
+              n = n.right
+              break
+            } else if (n.parent === this._root) {
+              n = null
+            } else {
+              n = n.parent._item
+            }
+          }
+        }
+      } while (n !== null && (n.deleted || !this._filter(/** @type {ContentType} */ (n.content).type)))
+    }
+    this._firstCall = false
+    if (n === null) {
+      // @ts-ignore
+      return { value: undefined, done: true }
+    }
+    this._currentNode = n
+    return { value: /** @type {any} */ (n.content).type, done: false }
+  }
+}
+
+/**
+ * Represents a list of {@link YXmlElement}.and {@link YXmlText} types.
+ * A YxmlFragment is similar to a {@link YXmlElement}, but it does not have a
+ * nodeName and it does not have attributes. Though it can be bound to a DOM
+ * element - in this case the attributes and the nodeName are not shared.
+ *
+ * @public
+ * @extends AbstractType<YXmlEvent>
+ */
+export class YXmlFragment extends AbstractType {
+  constructor () {
+    super()
+    /**
+     * @type {Array<any>|null}
+     * @private
+     */
+    this._prelimContent = []
+  }
+
+  /**
+   * Integrate this type into the Yjs instance.
+   *
+   * * Save this struct in the os
+   * * This type is sent to other client
+   * * Observer functions are fired
+   *
+   * @param {Doc} y The Yjs instance
+   * @param {Item} item
+   * @private
+   */
+  _integrate (y, item) {
+    super._integrate(y, item)
+    this.insert(0, /** @type {Array<any>} */ (this._prelimContent))
+    this._prelimContent = null
+  }
+
+  _copy () {
+    return new YXmlFragment()
+  }
+
+  get length () {
+    return this._prelimContent === null ? this._length : this._prelimContent.length
+  }
+
+  /**
+   * Create a subtree of childNodes.
+   *
+   * @example
+   * const walker = elem.createTreeWalker(dom => dom.nodeName === 'div')
+   * for (let node in walker) {
+   *   // `node` is a div node
+   *   nop(node)
+   * }
+   *
+   * @param {function(AbstractType<any>):boolean} filter Function that is called on each child element and
+   *                          returns a Boolean indicating whether the child
+   *                          is to be included in the subtree.
+   * @return {YXmlTreeWalker} A subtree and a position within it.
+   *
+   * @public
+   */
+  createTreeWalker (filter) {
+    return new YXmlTreeWalker(this, filter)
+  }
+
+  /**
+   * Returns the first YXmlElement that matches the query.
+   * Similar to DOM's {@link querySelector}.
+   *
+   * Query support:
+   *   - tagname
+   * TODO:
+   *   - id
+   *   - attribute
+   *
+   * @param {CSS_Selector} query The query on the children.
+   * @return {YXmlElement|YXmlText|YXmlHook|null} The first element that matches the query or null.
+   *
+   * @public
+   */
+  querySelector (query) {
+    query = query.toUpperCase()
+    // @ts-ignore
+    const iterator = new YXmlTreeWalker(this, element => element.nodeName && element.nodeName.toUpperCase() === query)
+    const next = iterator.next()
+    if (next.done) {
+      return null
+    } else {
+      return next.value
+    }
+  }
+
+  /**
+   * Returns all YXmlElements that match the query.
+   * Similar to Dom's {@link querySelectorAll}.
+   *
+   * @todo Does not yet support all queries. Currently only query by tagName.
+   *
+   * @param {CSS_Selector} query The query on the children
+   * @return {Array<YXmlElement|YXmlText|YXmlHook|null>} The elements that match this query.
+   *
+   * @public
+   */
+  querySelectorAll (query) {
+    query = query.toUpperCase()
+    // @ts-ignore
+    return Array.from(new YXmlTreeWalker(this, element => element.nodeName && element.nodeName.toUpperCase() === query))
+  }
+
+  /**
+   * Creates YXmlEvent and calls observers.
+   * @private
+   *
+   * @param {Transaction} transaction
+   * @param {Set<null|string>} parentSubs Keys changed on this type. `null` if list was modified.
+   */
+  _callObserver (transaction, parentSubs) {
+    callTypeObservers(this, transaction, new YXmlEvent(this, parentSubs, transaction))
+  }
+
+  /**
+   * Get the string representation of all the children of this YXmlFragment.
+   *
+   * @return {string} The string representation of all children.
+   */
+  toString () {
+    return typeListMap(this, xml => xml.toString()).join('')
+  }
+
+  /**
+   * @return {string}
+   */
+  toJSON () {
+    return this.toString()
+  }
+
+  /**
+   * Creates a Dom Element that mirrors this YXmlElement.
+   *
+   * @param {Document} [_document=document] The document object (you must define
+   *                                        this when calling this method in
+   *                                        nodejs)
+   * @param {Object<string, any>} [hooks={}] Optional property to customize how hooks
+   *                                             are presented in the DOM
+   * @param {any} [binding] You should not set this property. This is
+   *                               used if DomBinding wants to create a
+   *                               association to the created DOM type.
+   * @return {Node} The {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}
+   *
+   * @public
+   */
+  toDOM (_document = document, hooks = {}, binding) {
+    const fragment = _document.createDocumentFragment()
+    if (binding !== undefined) {
+      binding._createAssociation(fragment, this)
+    }
+    typeListForEach(this, xmlType => {
+      fragment.insertBefore(xmlType.toDOM(_document, hooks, binding), null)
+    })
+    return fragment
+  }
+
+  /**
+   * Inserts new content at an index.
+   *
+   * @example
+   *  // Insert character 'a' at position 0
+   *  xml.insert(0, [new Y.XmlText('text')])
+   *
+   * @param {number} index The index to insert content at
+   * @param {Array<YXmlElement|YXmlText>} content The array of content
+   */
+  insert (index, content) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeListInsertGenerics(transaction, this, index, content)
+      })
+    } else {
+      // @ts-ignore _prelimContent is defined because this is not yet integrated
+      this._prelimContent.splice(index, 0, ...content)
+    }
+  }
+
+  /**
+   * Deletes elements starting from an index.
+   *
+   * @param {number} index Index at which to start deleting elements
+   * @param {number} [length=1] The number of elements to remove. Defaults to 1.
+   */
+  delete (index, length = 1) {
+    if (this.doc !== null) {
+      transact(this.doc, transaction => {
+        typeListDelete(transaction, this, index, length)
+      })
+    } else {
+      // @ts-ignore _prelimContent is defined because this is not yet integrated
+      this._prelimContent.splice(index, length)
+    }
+  }
+
+  /**
+   * Transforms this YArray to a JavaScript Array.
+   *
+   * @return {Array<YXmlElement|YXmlText|YXmlHook>}
+   */
+  toArray () {
+    return typeListToArray(this)
+  }
+
+  /**
+   * Transform the properties of this type to binary and write it to an
+   * BinaryEncoder.
+   *
+   * This is called when this Item is sent to a remote peer.
+   *
+   * @private
+   * @param {encoding.Encoder} encoder The encoder to write data to.
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YXmlFragmentRefID)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {YXmlFragment}
+ *
+ * @private
+ * @function
+ */
+export const readYXmlFragment = decoder => new YXmlFragment()

src/types/YXmlHook.js

@@ -0,0 +1,90 @@
+
+import {
+  YMap,
+  YXmlHookRefID
+} from '../internals.js'
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+/**
+ * You can manage binding to a custom type with YXmlHook.
+ *
+ * @extends {YMap<any>}
+ */
+export class YXmlHook extends YMap {
+  /**
+   * @param {string} hookName nodeName of the Dom Node.
+   */
+  constructor (hookName) {
+    super()
+    /**
+     * @type {string}
+     */
+    this.hookName = hookName
+  }
+
+  /**
+   * Creates an Item with the same effect as this Item (without position effect)
+   *
+   * @private
+   */
+  _copy () {
+    return new YXmlHook(this.hookName)
+  }
+
+  /**
+   * Creates a Dom Element that mirrors this YXmlElement.
+   *
+   * @param {Document} [_document=document] The document object (you must define
+   *                                        this when calling this method in
+   *                                        nodejs)
+   * @param {Object.<string, any>} [hooks] Optional property to customize how hooks
+   *                                             are presented in the DOM
+   * @param {any} [binding] You should not set this property. This is
+   *                               used if DomBinding wants to create a
+   *                               association to the created DOM type
+   * @return {Element} The {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}
+   *
+   * @public
+   */
+  toDOM (_document = document, hooks = {}, binding) {
+    const hook = hooks[this.hookName]
+    let dom
+    if (hook !== undefined) {
+      dom = hook.createDom(this)
+    } else {
+      dom = document.createElement(this.hookName)
+    }
+    dom.setAttribute('data-yjs-hook', this.hookName)
+    if (binding !== undefined) {
+      binding._createAssociation(dom, this)
+    }
+    return dom
+  }
+
+  /**
+   * Transform the properties of this type to binary and write it to an
+   * BinaryEncoder.
+   *
+   * This is called when this Item is sent to a remote peer.
+   *
+   * @param {encoding.Encoder} encoder The encoder to write data to.
+   *
+   * @private
+   */
+  _write (encoder) {
+    super._write(encoder)
+    encoding.writeVarUint(encoder, YXmlHookRefID)
+    encoding.writeVarString(encoder, this.hookName)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {YXmlHook}
+ *
+ * @private
+ * @function
+ */
+export const readYXmlHook = decoder =>
+  new YXmlHook(decoding.readVarString(decoder))

src/types/YXmlText.js

@@ -0,0 +1,97 @@
+
+import { YText, YXmlTextRefID } from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+
+/**
+ * Represents text in a Dom Element. In the future this type will also handle
+ * simple formatting information like bold and italic.
+ */
+export class YXmlText extends YText {
+  _copy () {
+    return new YXmlText()
+  }
+
+  /**
+   * Creates a Dom Element that mirrors this YXmlText.
+   *
+   * @param {Document} [_document=document] The document object (you must define
+   *                                        this when calling this method in
+   *                                        nodejs)
+   * @param {Object<string, any>} [hooks] Optional property to customize how hooks
+   *                                             are presented in the DOM
+   * @param {any} [binding] You should not set this property. This is
+   *                               used if DomBinding wants to create a
+   *                               association to the created DOM type.
+   * @return {Text} The {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}
+   *
+   * @public
+   */
+  toDOM (_document = document, hooks, binding) {
+    const dom = _document.createTextNode(this.toString())
+    if (binding !== undefined) {
+      binding._createAssociation(dom, this)
+    }
+    return dom
+  }
+
+  toString () {
+    // @ts-ignore
+    return this.toDelta().map(delta => {
+      const nestedNodes = []
+      for (const nodeName in delta.attributes) {
+        const attrs = []
+        for (const key in delta.attributes[nodeName]) {
+          attrs.push({ key, value: delta.attributes[nodeName][key] })
+        }
+        // sort attributes to get a unique order
+        attrs.sort((a, b) => a.key < b.key ? -1 : 1)
+        nestedNodes.push({ nodeName, attrs })
+      }
+      // sort node order to get a unique order
+      nestedNodes.sort((a, b) => a.nodeName < b.nodeName ? -1 : 1)
+      // now convert to dom string
+      let str = ''
+      for (let i = 0; i < nestedNodes.length; i++) {
+        const node = nestedNodes[i]
+        str += `<${node.nodeName}`
+        for (let j = 0; j < node.attrs.length; j++) {
+          const attr = node.attrs[j]
+          str += ` ${attr.key}="${attr.value}"`
+        }
+        str += '>'
+      }
+      str += delta.insert
+      for (let i = nestedNodes.length - 1; i >= 0; i--) {
+        str += `</${nestedNodes[i].nodeName}>`
+      }
+      return str
+    }).join('')
+  }
+
+  /**
+   * @return {string}
+   */
+  toJSON () {
+    return this.toString()
+  }
+
+  /**
+   * @param {encoding.Encoder} encoder
+   *
+   * @private
+   */
+  _write (encoder) {
+    encoding.writeVarUint(encoder, YXmlTextRefID)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {YXmlText}
+ *
+ * @private
+ * @function
+ */
+export const readYXmlText = decoder => new YXmlText()

src/utils/DeleteSet.js

@@ -0,0 +1,314 @@
+
+import {
+  findIndexSS,
+  createID,
+  getState,
+  splitItem,
+  iterateStructs,
+  Item, GC, StructStore, Transaction, ID // eslint-disable-line
+} from '../internals.js'
+
+import * as array from 'lib0/array.js'
+import * as math from 'lib0/math.js'
+import * as map from 'lib0/map.js'
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+export class DeleteItem {
+  /**
+   * @param {number} clock
+   * @param {number} len
+   */
+  constructor (clock, len) {
+    /**
+     * @type {number}
+     */
+    this.clock = clock
+    /**
+     * @type {number}
+     */
+    this.len = len
+  }
+}
+
+/**
+ * We no longer maintain a DeleteStore. DeleteSet is a temporary object that is created when needed.
+ * - When created in a transaction, it must only be accessed after sorting, and merging
+ *   - This DeleteSet is send to other clients
+ * - We do not create a DeleteSet when we send a sync message. The DeleteSet message is created directly from StructStore
+ * - We read a DeleteSet as part of a sync/update message. In this case the DeleteSet is already sorted and merged.
+ */
+export class DeleteSet {
+  constructor () {
+    /**
+     * @type {Map<number,Array<DeleteItem>>}
+     * @private
+     */
+    this.clients = new Map()
+  }
+}
+
+/**
+ * Iterate over all structs that the DeleteSet gc's.
+ *
+ * @param {Transaction} transaction
+ * @param {DeleteSet} ds
+ * @param {function(GC|Item):void} f
+ *
+ * @function
+ */
+export const iterateDeletedStructs = (transaction, ds, f) =>
+  ds.clients.forEach((deletes, clientid) => {
+    const structs = /** @type {Array<GC|Item>} */ (transaction.doc.store.clients.get(clientid))
+    for (let i = 0; i < deletes.length; i++) {
+      const del = deletes[i]
+      iterateStructs(transaction, structs, del.clock, del.len, f)
+    }
+  })
+
+/**
+ * @param {Array<DeleteItem>} dis
+ * @param {number} clock
+ * @return {number|null}
+ *
+ * @private
+ * @function
+ */
+export const findIndexDS = (dis, clock) => {
+  let left = 0
+  let right = dis.length - 1
+  while (left <= right) {
+    const midindex = math.floor((left + right) / 2)
+    const mid = dis[midindex]
+    const midclock = mid.clock
+    if (midclock <= clock) {
+      if (clock < midclock + mid.len) {
+        return midindex
+      }
+      left = midindex + 1
+    } else {
+      right = midindex - 1
+    }
+  }
+  return null
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {ID} id
+ * @return {boolean}
+ *
+ * @private
+ * @function
+ */
+export const isDeleted = (ds, id) => {
+  const dis = ds.clients.get(id.client)
+  return dis !== undefined && findIndexDS(dis, id.clock) !== null
+}
+
+/**
+ * @param {DeleteSet} ds
+ *
+ * @private
+ * @function
+ */
+export const sortAndMergeDeleteSet = ds => {
+  ds.clients.forEach(dels => {
+    dels.sort((a, b) => a.clock - b.clock)
+    // merge items without filtering or splicing the array
+    // i is the current pointer
+    // j refers to the current insert position for the pointed item
+    // try to merge dels[i] into dels[j-1] or set dels[j]=dels[i]
+    let i, j
+    for (i = 1, j = 1; i < dels.length; i++) {
+      const left = dels[j - 1]
+      const right = dels[i]
+      if (left.clock + left.len === right.clock) {
+        left.len += right.len
+      } else {
+        if (j < i) {
+          dels[j] = right
+        }
+        j++
+      }
+    }
+    dels.length = j
+  })
+}
+
+/**
+ * @param {Array<DeleteSet>} dss
+ * @return {DeleteSet} A fresh DeleteSet
+ */
+export const mergeDeleteSets = dss => {
+  const merged = new DeleteSet()
+  for (let dssI = 0; dssI < dss.length; dssI++) {
+    dss[dssI].clients.forEach((delsLeft, client) => {
+      if (!merged.clients.has(client)) {
+        // Write all missing keys from current ds and all following.
+        // If merged already contains `client` current ds has already been added.
+        /**
+         * @type {Array<DeleteItem>}
+         */
+        const dels = delsLeft.slice()
+        for (let i = dssI + 1; i < dss.length; i++) {
+          array.appendTo(dels, dss[i].clients.get(client) || [])
+        }
+        merged.clients.set(client, dels)
+      }
+    })
+  }
+  sortAndMergeDeleteSet(merged)
+  return merged
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {ID} id
+ * @param {number} length
+ *
+ * @private
+ * @function
+ */
+export const addToDeleteSet = (ds, id, length) => {
+  map.setIfUndefined(ds.clients, id.client, () => []).push(new DeleteItem(id.clock, length))
+}
+
+export const createDeleteSet = () => new DeleteSet()
+
+/**
+ * @param {StructStore} ss
+ * @return {DeleteSet} Merged and sorted DeleteSet
+ *
+ * @private
+ * @function
+ */
+export const createDeleteSetFromStructStore = ss => {
+  const ds = createDeleteSet()
+  ss.clients.forEach((structs, client) => {
+    /**
+     * @type {Array<DeleteItem>}
+     */
+    const dsitems = []
+    for (let i = 0; i < structs.length; i++) {
+      const struct = structs[i]
+      if (struct.deleted) {
+        const clock = struct.id.clock
+        let len = struct.length
+        if (i + 1 < structs.length) {
+          for (let next = structs[i + 1]; i + 1 < structs.length && next.id.clock === clock + len && next.deleted; next = structs[++i + 1]) {
+            len += next.length
+          }
+        }
+        dsitems.push(new DeleteItem(clock, len))
+      }
+    }
+    if (dsitems.length > 0) {
+      ds.clients.set(client, dsitems)
+    }
+  })
+  return ds
+}
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {DeleteSet} ds
+ *
+ * @private
+ * @function
+ */
+export const writeDeleteSet = (encoder, ds) => {
+  encoding.writeVarUint(encoder, ds.clients.size)
+  ds.clients.forEach((dsitems, client) => {
+    encoding.writeVarUint(encoder, client)
+    const len = dsitems.length
+    encoding.writeVarUint(encoder, len)
+    for (let i = 0; i < len; i++) {
+      const item = dsitems[i]
+      encoding.writeVarUint(encoder, item.clock)
+      encoding.writeVarUint(encoder, item.len)
+    }
+  })
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {DeleteSet}
+ *
+ * @private
+ * @function
+ */
+export const readDeleteSet = decoder => {
+  const ds = new DeleteSet()
+  const numClients = decoding.readVarUint(decoder)
+  for (let i = 0; i < numClients; i++) {
+    const client = decoding.readVarUint(decoder)
+    const numberOfDeletes = decoding.readVarUint(decoder)
+    for (let i = 0; i < numberOfDeletes; i++) {
+      addToDeleteSet(ds, createID(client, decoding.readVarUint(decoder)), decoding.readVarUint(decoder))
+    }
+  }
+  return ds
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @param {Transaction} transaction
+ * @param {StructStore} store
+ *
+ * @private
+ * @function
+ */
+export const readAndApplyDeleteSet = (decoder, transaction, store) => {
+  const unappliedDS = new DeleteSet()
+  const numClients = decoding.readVarUint(decoder)
+  for (let i = 0; i < numClients; i++) {
+    const client = decoding.readVarUint(decoder)
+    const numberOfDeletes = decoding.readVarUint(decoder)
+    const structs = store.clients.get(client) || []
+    const state = getState(store, client)
+    for (let i = 0; i < numberOfDeletes; i++) {
+      const clock = decoding.readVarUint(decoder)
+      const len = decoding.readVarUint(decoder)
+      if (clock < state) {
+        if (state < clock + len) {
+          addToDeleteSet(unappliedDS, createID(client, state), clock + len - state)
+        }
+        let index = findIndexSS(structs, clock)
+        /**
+         * We can ignore the case of GC and Delete structs, because we are going to skip them
+         * @type {Item}
+         */
+        // @ts-ignore
+        let struct = structs[index]
+        // split the first item if necessary
+        if (!struct.deleted && struct.id.clock < clock) {
+          structs.splice(index + 1, 0, splitItem(transaction, struct, clock - struct.id.clock))
+          index++ // increase we now want to use the next struct
+        }
+        while (index < structs.length) {
+          // @ts-ignore
+          struct = structs[index++]
+          if (struct.id.clock < clock + len) {
+            if (!struct.deleted) {
+              if (clock + len < struct.id.clock + struct.length) {
+                structs.splice(index, 0, splitItem(transaction, struct, clock + len - struct.id.clock))
+              }
+              struct.delete(transaction)
+            }
+          } else {
+            break
+          }
+        }
+      } else {
+        addToDeleteSet(unappliedDS, createID(client, clock), len)
+      }
+    }
+  }
+  if (unappliedDS.clients.size > 0) {
+    // TODO: no need for encoding+decoding ds anymore
+    const unappliedDSEncoder = encoding.createEncoder()
+    writeDeleteSet(unappliedDSEncoder, unappliedDS)
+    store.pendingDeleteReaders.push(decoding.createDecoder(encoding.toUint8Array(unappliedDSEncoder)))
+  }
+}

src/utils/Doc.js

@@ -0,0 +1,196 @@
+/**
+ * @module Y
+ */
+
+import {
+  StructStore,
+  AbstractType,
+  YArray,
+  YText,
+  YMap,
+  YXmlFragment,
+  transact,
+  Item, Transaction, YEvent // eslint-disable-line
+} from '../internals.js'
+
+import { Observable } from 'lib0/observable.js'
+import * as random from 'lib0/random.js'
+import * as map from 'lib0/map.js'
+
+/**
+ * A Yjs instance handles the state of shared data.
+ * @extends Observable<string>
+ */
+export class Doc extends Observable {
+  /**
+   * @param {Object} conf configuration
+   * @param {boolean} [conf.gc] Disable garbage collection (default: gc=true)
+   * @param {function(Item):boolean} [conf.gcFilter] Will be called before an Item is garbage collected. Return false to keep the Item.
+   */
+  constructor ({ gc = true, gcFilter = () => true } = {}) {
+    super()
+    this.gc = gc
+    this.gcFilter = gcFilter
+    this.clientID = random.uint32()
+    /**
+     * @type {Map<string, AbstractType<YEvent>>}
+     */
+    this.share = new Map()
+    this.store = new StructStore()
+    /**
+     * @type {Transaction | null}
+     * @private
+     */
+    this._transaction = null
+    /**
+     * @type {Array<Transaction>}
+     * @private
+     */
+    this._transactionCleanups = []
+  }
+
+  /**
+   * Changes that happen inside of a transaction are bundled. This means that
+   * the observer fires _after_ the transaction is finished and that all changes
+   * that happened inside of the transaction are sent as one message to the
+   * other peers.
+   *
+   * @param {function(Transaction):void} f The function that should be executed as a transaction
+   * @param {any} [origin] Origin of who started the transaction. Will be stored on transaction.origin
+   *
+   * @public
+   */
+  transact (f, origin = null) {
+    transact(this, f, origin)
+  }
+
+  /**
+   * Define a shared data type.
+   *
+   * Multiple calls of `y.get(name, TypeConstructor)` yield the same result
+   * and do not overwrite each other. I.e.
+   * `y.define(name, Y.Array) === y.define(name, Y.Array)`
+   *
+   * After this method is called, the type is also available on `y.share.get(name)`.
+   *
+   * *Best Practices:*
+   * Define all types right after the Yjs instance is created and store them in a separate object.
+   * Also use the typed methods `getText(name)`, `getArray(name)`, ..
+   *
+   * @example
+   *   const y = new Y(..)
+   *   const appState = {
+   *     document: y.getText('document')
+   *     comments: y.getArray('comments')
+   *   }
+   *
+   * @param {string} name
+   * @param {Function} TypeConstructor The constructor of the type definition. E.g. Y.Text, Y.Array, Y.Map, ...
+   * @return {AbstractType<any>} The created type. Constructed with TypeConstructor
+   *
+   * @public
+   */
+  get (name, TypeConstructor = AbstractType) {
+    const type = map.setIfUndefined(this.share, name, () => {
+      // @ts-ignore
+      const t = new TypeConstructor()
+      t._integrate(this, null)
+      return t
+    })
+    const Constr = type.constructor
+    if (TypeConstructor !== AbstractType && Constr !== TypeConstructor) {
+      if (Constr === AbstractType) {
+        // @ts-ignore
+        const t = new TypeConstructor()
+        t._map = type._map
+        type._map.forEach(/** @param {Item?} n */ n => {
+          for (; n !== null; n = n.left) {
+            n.parent = t
+          }
+        })
+        t._start = type._start
+        for (let n = t._start; n !== null; n = n.right) {
+          n.parent = t
+        }
+        t._length = type._length
+        this.share.set(name, t)
+        t._integrate(this, null)
+        return t
+      } else {
+        throw new Error(`Type with the name ${name} has already been defined with a different constructor`)
+      }
+    }
+    return type
+  }
+
+  /**
+   * @template T
+   * @param {string} name
+   * @return {YArray<T>}
+   *
+   * @public
+   */
+  getArray (name) {
+    // @ts-ignore
+    return this.get(name, YArray)
+  }
+
+  /**
+   * @param {string} name
+   * @return {YText}
+   *
+   * @public
+   */
+  getText (name) {
+    // @ts-ignore
+    return this.get(name, YText)
+  }
+
+  /**
+   * @param {string} name
+   * @return {YMap<any>}
+   *
+   * @public
+   */
+  getMap (name) {
+    // @ts-ignore
+    return this.get(name, YMap)
+  }
+
+  /**
+   * @param {string} name
+   * @return {YXmlFragment}
+   *
+   * @public
+   */
+  getXmlFragment (name) {
+    // @ts-ignore
+    return this.get(name, YXmlFragment)
+  }
+
+  /**
+   * Emit `destroy` event and unregister all event handlers.
+   *
+   * @protected
+   */
+  destroy () {
+    this.emit('destroyed', [true])
+    super.destroy()
+  }
+
+  /**
+   * @param {string} eventName
+   * @param {function} f
+   */
+  on (eventName, f) {
+    super.on(eventName, f)
+  }
+
+  /**
+   * @param {string} eventName
+   * @param {function} f
+   */
+  off (eventName, f) {
+    super.off(eventName, f)
+  }
+}

src/utils/EventHandler.js

@@ -0,0 +1,82 @@
+import * as f from 'lib0/function.js'
+
+/**
+ * General event handler implementation.
+ *
+ * @template ARG0, ARG1
+ *
+ * @private
+ */
+export class EventHandler {
+  constructor () {
+    /**
+     * @type {Array<function(ARG0, ARG1):void>}
+     */
+    this.l = []
+  }
+}
+
+/**
+ * @template ARG0,ARG1
+ * @returns {EventHandler<ARG0,ARG1>}
+ *
+ * @private
+ * @function
+ */
+export const createEventHandler = () => new EventHandler()
+
+/**
+ * Adds an event listener that is called when
+ * {@link EventHandler#callEventListeners} is called.
+ *
+ * @template ARG0,ARG1
+ * @param {EventHandler<ARG0,ARG1>} eventHandler
+ * @param {function(ARG0,ARG1):void} f The event handler.
+ *
+ * @private
+ * @function
+ */
+export const addEventHandlerListener = (eventHandler, f) =>
+  eventHandler.l.push(f)
+
+/**
+ * Removes an event listener.
+ *
+ * @template ARG0,ARG1
+ * @param {EventHandler<ARG0,ARG1>} eventHandler
+ * @param {function(ARG0,ARG1):void} f The event handler that was added with
+ *                     {@link EventHandler#addEventListener}
+ *
+ * @private
+ * @function
+ */
+export const removeEventHandlerListener = (eventHandler, f) => {
+  eventHandler.l = eventHandler.l.filter(g => f !== g)
+}
+
+/**
+ * Removes all event listeners.
+ * @template ARG0,ARG1
+ * @param {EventHandler<ARG0,ARG1>} eventHandler
+ *
+ * @private
+ * @function
+ */
+export const removeAllEventHandlerListeners = eventHandler => {
+  eventHandler.l.length = 0
+}
+
+/**
+ * Call all event listeners that were added via
+ * {@link EventHandler#addEventListener}.
+ *
+ * @template ARG0,ARG1
+ * @param {EventHandler<ARG0,ARG1>} eventHandler
+ * @param {ARG0} arg0
+ * @param {ARG1} arg1
+ *
+ * @private
+ * @function
+ */
+export const callEventHandlerListeners = (eventHandler, arg0, arg1) =>
+  f.callAll(eventHandler.l, [arg0, arg1])

src/utils/ID.js

@@ -0,0 +1,90 @@
+
+import { AbstractType } from '../internals.js' // eslint-disable-line
+
+import * as decoding from 'lib0/decoding.js'
+import * as encoding from 'lib0/encoding.js'
+import * as error from 'lib0/error.js'
+
+export class ID {
+  /**
+   * @param {number} client client id
+   * @param {number} clock unique per client id, continuous number
+   */
+  constructor (client, clock) {
+    /**
+     * Client id
+     * @type {number}
+     */
+    this.client = client
+    /**
+     * unique per client id, continuous number
+     * @type {number}
+     */
+    this.clock = clock
+  }
+}
+
+/**
+ * @param {ID | null} a
+ * @param {ID | null} b
+ * @return {boolean}
+ *
+ * @function
+ */
+export const compareIDs = (a, b) => a === b || (a !== null && b !== null && a.client === b.client && a.clock === b.clock)
+
+/**
+ * @param {number} client
+ * @param {number} clock
+ *
+ * @private
+ * @function
+ */
+export const createID = (client, clock) => new ID(client, clock)
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {ID} id
+ *
+ * @private
+ * @function
+ */
+export const writeID = (encoder, id) => {
+  encoding.writeVarUint(encoder, id.client)
+  encoding.writeVarUint(encoder, id.clock)
+}
+
+/**
+ * Read ID.
+ * * If first varUint read is 0xFFFFFF a RootID is returned.
+ * * Otherwise an ID is returned
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {ID}
+ *
+ * @private
+ * @function
+ */
+export const readID = decoder =>
+  createID(decoding.readVarUint(decoder), decoding.readVarUint(decoder))
+
+/**
+ * The top types are mapped from y.share.get(keyname) => type.
+ * `type` does not store any information about the `keyname`.
+ * This function finds the correct `keyname` for `type` and throws otherwise.
+ *
+ * @param {AbstractType<any>} type
+ * @return {string}
+ *
+ * @private
+ * @function
+ */
+export const findRootTypeKey = type => {
+  // @ts-ignore _y must be defined, otherwise unexpected case
+  for (const [key, value] of type.doc.share) {
+    if (value === type) {
+      return key
+    }
+  }
+  throw error.unexpectedCase()
+}

src/utils/PermanentUserData.js

@@ -0,0 +1,142 @@
+
+import {
+  YArray,
+  YMap,
+  readDeleteSet,
+  writeDeleteSet,
+  createDeleteSet,
+  ID, DeleteSet, YArrayEvent, Transaction, Doc // eslint-disable-line
+} from '../internals.js'
+
+import * as decoding from 'lib0/decoding.js'
+import * as encoding from 'lib0/encoding.js'
+import { mergeDeleteSets, isDeleted } from './DeleteSet.js'
+
+export class PermanentUserData {
+  /**
+   * @param {Doc} doc
+   * @param {YMap<any>} [storeType]
+   */
+  constructor (doc, storeType = doc.getMap('users')) {
+    /**
+     * @type {Map<string,DeleteSet>}
+     */
+    const dss = new Map()
+    this.yusers = storeType
+    this.doc = doc
+    /**
+     * Maps from clientid to userDescription
+     *
+     * @type {Map<number,string>}
+     */
+    this.clients = new Map()
+    this.dss = dss
+    /**
+     * @param {YMap<any>} user
+     * @param {string} userDescription
+     */
+    const initUser = (user, userDescription) => {
+      /**
+       * @type {YArray<Uint8Array>}
+       */
+      const ds = user.get('ds')
+      const ids = user.get('ids')
+      const addClientId = /** @param {number} clientid */ clientid => this.clients.set(clientid, userDescription)
+      ds.observe(/** @param {YArrayEvent<any>} event */ event => {
+        event.changes.added.forEach(item => {
+          item.content.getContent().forEach(encodedDs => {
+            if (encodedDs instanceof Uint8Array) {
+              this.dss.set(userDescription, mergeDeleteSets([this.dss.get(userDescription) || createDeleteSet(), readDeleteSet(decoding.createDecoder(encodedDs))]))
+            }
+          })
+        })
+      })
+      this.dss.set(userDescription, mergeDeleteSets(ds.map(encodedDs => readDeleteSet(decoding.createDecoder(encodedDs)))))
+      ids.observe(/** @param {YArrayEvent<any>} event */ event =>
+        event.changes.added.forEach(item => item.content.getContent().forEach(addClientId))
+      )
+      ids.forEach(addClientId)
+    }
+    // observe users
+    storeType.observe(event => {
+      event.keysChanged.forEach(userDescription =>
+        initUser(storeType.get(userDescription), userDescription)
+      )
+    })
+    // add intial data
+    storeType.forEach(initUser)
+  }
+
+  /**
+   * @param {Doc} doc
+   * @param {number} clientid
+   * @param {string} userDescription
+   * @param {Object} [conf]
+   * @param {function(Transaction, DeleteSet):boolean} [conf.filter]
+   */
+  setUserMapping (doc, clientid, userDescription, { filter = () => true } = {}) {
+    const users = this.yusers
+    let user = users.get(userDescription)
+    if (!user) {
+      user = new YMap()
+      user.set('ids', new YArray())
+      user.set('ds', new YArray())
+      users.set(userDescription, user)
+    }
+    user.get('ids').push([clientid])
+    users.observe(event => {
+      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)])
+          }
+        }
+      }, 0)
+    })
+    doc.on('afterTransaction', /** @param {Transaction} transaction */ transaction => {
+      setTimeout(() => {
+        const yds = user.get('ds')
+        const ds = transaction.deleteSet
+        if (transaction.local && ds.clients.size > 0 && filter(transaction, ds)) {
+          const encoder = encoding.createEncoder()
+          writeDeleteSet(encoder, ds)
+          yds.push([encoding.toUint8Array(encoder)])
+        }
+      })
+    })
+  }
+
+  /**
+   * @param {number} clientid
+   * @return {any}
+   */
+  getUserByClientId (clientid) {
+    return this.clients.get(clientid) || null
+  }
+
+  /**
+   * @param {ID} id
+   * @return {string | null}
+   */
+  getUserByDeletedId (id) {
+    for (const [userDescription, ds] of this.dss) {
+      if (isDeleted(ds, id)) {
+        return userDescription
+      }
+    }
+    return null
+  }
+}

src/utils/RelativePosition.js

@@ -0,0 +1,272 @@
+
+import {
+  createID,
+  writeID,
+  readID,
+  compareIDs,
+  getState,
+  findRootTypeKey,
+  Item,
+  ContentType,
+  followRedone,
+  ID, Doc, AbstractType // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as error from 'lib0/error.js'
+
+/**
+ * A relative position is based on the Yjs model and is not affected by document changes.
+ * E.g. If you place a relative position before a certain character, it will always point to this character.
+ * If you place a relative position at the end of a type, it will always point to the end of the type.
+ *
+ * A numeric position is often unsuited for user selections, because it does not change when content is inserted
+ * before or after.
+ *
+ * ```Insert(0, 'x')('a|bc') = 'xa|bc'``` Where | is the relative position.
+ *
+ * One of the properties must be defined.
+ *
+ * @example
+ *   // Current cursor position is at position 10
+ *   const relativePosition = createRelativePositionFromIndex(yText, 10)
+ *   // modify yText
+ *   yText.insert(0, 'abc')
+ *   yText.delete(3, 10)
+ *   // Compute the cursor position
+ *   const absolutePosition = createAbsolutePositionFromRelativePosition(y, relativePosition)
+ *   absolutePosition.type === yText // => true
+ *   console.log('cursor location is ' + absolutePosition.index) // => cursor location is 3
+ *
+ */
+export class RelativePosition {
+  /**
+   * @param {ID|null} type
+   * @param {string|null} tname
+   * @param {ID|null} item
+   */
+  constructor (type, tname, item) {
+    /**
+     * @type {ID|null}
+     */
+    this.type = type
+    /**
+     * @type {string|null}
+     */
+    this.tname = tname
+    /**
+     * @type {ID | null}
+     */
+    this.item = item
+  }
+}
+
+/**
+ * @param {any} json
+ * @return {RelativePosition}
+ *
+ * @function
+ */
+export const createRelativePositionFromJSON = json => new RelativePosition(json.type == null ? null : createID(json.type.client, json.type.clock), json.tname || null, json.item == null ? null : createID(json.item.client, json.item.clock))
+
+export class AbsolutePosition {
+  /**
+   * @param {AbstractType<any>} type
+   * @param {number} index
+   */
+  constructor (type, index) {
+    /**
+     * @type {AbstractType<any>}
+     */
+    this.type = type
+    /**
+     * @type {number}
+     */
+    this.index = index
+  }
+}
+
+/**
+ * @param {AbstractType<any>} type
+ * @param {number} index
+ *
+ * @function
+ */
+export const createAbsolutePosition = (type, index) => new AbsolutePosition(type, index)
+
+/**
+ * @param {AbstractType<any>} type
+ * @param {ID|null} item
+ *
+ * @function
+ */
+export const createRelativePosition = (type, item) => {
+  let typeid = null
+  let tname = null
+  if (type._item === null) {
+    tname = findRootTypeKey(type)
+  } else {
+    typeid = type._item.id
+  }
+  return new RelativePosition(typeid, tname, item)
+}
+
+/**
+ * Create a relativePosition based on a absolute position.
+ *
+ * @param {AbstractType<any>} type The base type (e.g. YText or YArray).
+ * @param {number} index The absolute position.
+ * @return {RelativePosition}
+ *
+ * @function
+ */
+export const createRelativePositionFromTypeIndex = (type, index) => {
+  let t = type._start
+  while (t !== null) {
+    if (!t.deleted && t.countable) {
+      if (t.length > index) {
+        // case 1: found position somewhere in the linked list
+        return createRelativePosition(type, createID(t.id.client, t.id.clock + index))
+      }
+      index -= t.length
+    }
+    t = t.right
+  }
+  return createRelativePosition(type, null)
+}
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {RelativePosition} rpos
+ *
+ * @function
+ */
+export const writeRelativePosition = (encoder, rpos) => {
+  const { type, tname, item } = rpos
+  if (item !== null) {
+    encoding.writeVarUint(encoder, 0)
+    writeID(encoder, item)
+  } else if (tname !== null) {
+    // case 2: found position at the end of the list and type is stored in y.share
+    encoding.writeUint8(encoder, 1)
+    encoding.writeVarString(encoder, tname)
+  } else if (type !== null) {
+    // case 3: found position at the end of the list and type is attached to an item
+    encoding.writeUint8(encoder, 2)
+    writeID(encoder, type)
+  } else {
+    throw error.unexpectedCase()
+  }
+  return encoder
+}
+
+/**
+ * @param {RelativePosition} rpos
+ * @return {Uint8Array}
+ */
+export const encodeRelativePosition = rpos => {
+  const encoder = encoding.createEncoder()
+  writeRelativePosition(encoder, rpos)
+  return encoding.toUint8Array(encoder)
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @return {RelativePosition|null}
+ *
+ * @function
+ */
+export const readRelativePosition = decoder => {
+  let type = null
+  let tname = null
+  let itemID = null
+  switch (decoding.readVarUint(decoder)) {
+    case 0:
+      // case 1: found position somewhere in the linked list
+      itemID = readID(decoder)
+      break
+    case 1:
+      // case 2: found position at the end of the list and type is stored in y.share
+      tname = decoding.readVarString(decoder)
+      break
+    case 2: {
+      // case 3: found position at the end of the list and type is attached to an item
+      type = readID(decoder)
+    }
+  }
+  return new RelativePosition(type, tname, itemID)
+}
+
+/**
+ * @param {Uint8Array} uint8Array
+ * @return {RelativePosition|null}
+ */
+export const decodeRelativePosition = uint8Array => readRelativePosition(decoding.createDecoder(uint8Array))
+
+/**
+ * @param {RelativePosition} rpos
+ * @param {Doc} doc
+ * @return {AbsolutePosition|null}
+ *
+ * @function
+ */
+export const createAbsolutePositionFromRelativePosition = (rpos, doc) => {
+  const store = doc.store
+  const rightID = rpos.item
+  const typeID = rpos.type
+  const tname = rpos.tname
+  let type = null
+  let index = 0
+  if (rightID !== null) {
+    if (getState(store, rightID.client) <= rightID.clock) {
+      return null
+    }
+    const res = followRedone(store, rightID)
+    const right = res.item
+    if (!(right instanceof Item)) {
+      return null
+    }
+    type = right.parent
+    if (type._item === null || !type._item.deleted) {
+      index = right.deleted || !right.countable ? 0 : res.diff
+      let n = right.left
+      while (n !== null) {
+        if (!n.deleted && n.countable) {
+          index += n.length
+        }
+        n = n.left
+      }
+    }
+  } else {
+    if (tname !== null) {
+      type = doc.get(tname)
+    } else if (typeID !== null) {
+      if (getState(store, typeID.client) <= typeID.clock) {
+        // type does not exist yet
+        return null
+      }
+      const { item } = followRedone(store, typeID)
+      if (item instanceof Item && item.content instanceof ContentType) {
+        type = item.content.type
+      } else {
+        // struct is garbage collected
+        return null
+      }
+    } else {
+      throw error.unexpectedCase()
+    }
+    index = type._length
+  }
+  return createAbsolutePosition(type, index)
+}
+
+/**
+ * @param {RelativePosition|null} a
+ * @param {RelativePosition|null} b
+ *
+ * @function
+ */
+export const compareRelativePositions = (a, b) => a === b || (
+  a !== null && b !== null && a.tname === b.tname && compareIDs(a.item, b.item) && compareIDs(a.type, b.type)
+)

src/utils/Snapshot.js

@@ -0,0 +1,140 @@
+
+import {
+  isDeleted,
+  createDeleteSetFromStructStore,
+  getStateVector,
+  getItemCleanStart,
+  createID,
+  iterateDeletedStructs,
+  writeDeleteSet,
+  writeStateVector,
+  readDeleteSet,
+  readStateVector,
+  createDeleteSet,
+  getState,
+  Transaction, Doc, DeleteSet, Item // eslint-disable-line
+} from '../internals.js'
+
+import * as map from 'lib0/map.js'
+import * as set from 'lib0/set.js'
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+
+export class Snapshot {
+  /**
+   * @param {DeleteSet} ds
+   * @param {Map<number,number>} sv state map
+   */
+  constructor (ds, sv) {
+    /**
+     * @type {DeleteSet}
+     * @private
+     */
+    this.ds = ds
+    /**
+     * State Map
+     * @type {Map<number,number>}
+     * @private
+     */
+    this.sv = sv
+  }
+}
+
+/**
+ * @param {Snapshot} snap1
+ * @param {Snapshot} snap2
+ * @return {boolean}
+ */
+export const equalSnapshots = (snap1, snap2) => {
+  const ds1 = snap1.ds.clients
+  const ds2 = snap2.ds.clients
+  const sv1 = snap1.sv
+  const sv2 = snap2.sv
+  if (sv1.size !== sv2.size || ds1.size !== ds2.size) {
+    return false
+  }
+  for (const [key, value] of sv1) {
+    if (sv2.get(key) !== value) {
+      return false
+    }
+  }
+  for (const [client, dsitems1] of ds1) {
+    const dsitems2 = ds2.get(client) || []
+    if (dsitems1.length !== dsitems2.length) {
+      return false
+    }
+    for (let i = 0; i < dsitems1.length; i++) {
+      const dsitem1 = dsitems1[i]
+      const dsitem2 = dsitems2[i]
+      if (dsitem1.clock !== dsitem2.clock || dsitem1.len !== dsitem2.len) {
+        return false
+      }
+    }
+  }
+  return true
+}
+
+/**
+ * @param {Snapshot} snapshot
+ * @return {Uint8Array}
+ */
+export const encodeSnapshot = snapshot => {
+  const encoder = encoding.createEncoder()
+  writeDeleteSet(encoder, snapshot.ds)
+  writeStateVector(encoder, snapshot.sv)
+  return encoding.toUint8Array(encoder)
+}
+
+/**
+ * @param {Uint8Array} buf
+ * @return {Snapshot}
+ */
+export const decodeSnapshot = buf => {
+  const decoder = decoding.createDecoder(buf)
+  return new Snapshot(readDeleteSet(decoder), readStateVector(decoder))
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {Map<number,number>} sm
+ * @return {Snapshot}
+ */
+export const createSnapshot = (ds, sm) => new Snapshot(ds, sm)
+
+export const emptySnapshot = createSnapshot(createDeleteSet(), new Map())
+
+/**
+ * @param {Doc} doc
+ * @return {Snapshot}
+ */
+export const snapshot = doc => createSnapshot(createDeleteSetFromStructStore(doc.store), getStateVector(doc.store))
+
+/**
+ * @param {Item} item
+ * @param {Snapshot|undefined} snapshot
+ *
+ * @protected
+ * @function
+ */
+export const isVisible = (item, snapshot) => snapshot === undefined ? !item.deleted : (
+  snapshot.sv.has(item.id.client) && (snapshot.sv.get(item.id.client) || 0) > item.id.clock && !isDeleted(snapshot.ds, item.id)
+)
+
+/**
+ * @param {Transaction} transaction
+ * @param {Snapshot} snapshot
+ */
+export const splitSnapshotAffectedStructs = (transaction, snapshot) => {
+  const meta = map.setIfUndefined(transaction.meta, splitSnapshotAffectedStructs, set.create)
+  const store = transaction.doc.store
+  // check if we already split for this snapshot
+  if (!meta.has(snapshot)) {
+    snapshot.sv.forEach((clock, client) => {
+      if (clock < getState(store, client)) {
+        getItemCleanStart(transaction, createID(client, clock))
+      }
+    })
+    iterateDeletedStructs(transaction, snapshot.ds, item => {})
+    meta.add(snapshot)
+  }
+}

src/utils/StructStore.js

@@ -0,0 +1,275 @@
+
+import {
+  GC,
+  splitItem,
+  GCRef, ItemRef, Transaction, ID, Item // eslint-disable-line
+} from '../internals.js'
+
+import * as math from 'lib0/math.js'
+import * as error from 'lib0/error.js'
+import * as decoding from 'lib0/decoding.js' // eslint-disable-line
+
+export class StructStore {
+  constructor () {
+    /**
+     * @type {Map<number,Array<GC|Item>>}
+     * @private
+     */
+    this.clients = new Map()
+    /**
+     * Store incompleted struct reads here
+     * `i` denotes to the next read operation
+     * We could shift the array of refs instead, but shift is incredible
+     * slow in Chrome for arrays with more than 100k elements
+     * @see tryResumePendingStructRefs
+     * @type {Map<number,{i:number,refs:Array<GCRef|ItemRef>}>}
+     * @private
+     */
+    this.pendingClientsStructRefs = new Map()
+    /**
+     * Stack of pending structs waiting for struct dependencies
+     * Maximum length of stack is structReaders.size
+     * @type {Array<GCRef|ItemRef>}
+     * @private
+     */
+    this.pendingStack = []
+    /**
+     * @type {Array<decoding.Decoder>}
+     * @private
+     */
+    this.pendingDeleteReaders = []
+  }
+}
+
+/**
+ * Return the states as a Map<client,clock>.
+ * Note that clock refers to the next expected clock id.
+ *
+ * @param {StructStore} store
+ * @return {Map<number,number>}
+ *
+ * @public
+ * @function
+ */
+export const getStateVector = store => {
+  const sm = new Map()
+  store.clients.forEach((structs, client) => {
+    const struct = structs[structs.length - 1]
+    sm.set(client, struct.id.clock + struct.length)
+  })
+  return sm
+}
+
+/**
+ * @param {StructStore} store
+ * @param {number} client
+ * @return {number}
+ *
+ * @public
+ * @function
+ */
+export const getState = (store, client) => {
+  const structs = store.clients.get(client)
+  if (structs === undefined) {
+    return 0
+  }
+  const lastStruct = structs[structs.length - 1]
+  return lastStruct.id.clock + lastStruct.length
+}
+
+/**
+ * @param {StructStore} store
+ *
+ * @private
+ * @function
+ */
+export const integretyCheck = store => {
+  store.clients.forEach(structs => {
+    for (let i = 1; i < structs.length; i++) {
+      const l = structs[i - 1]
+      const r = structs[i]
+      if (l.id.clock + l.length !== r.id.clock) {
+        throw new Error('StructStore failed integrety check')
+      }
+    }
+  })
+}
+
+/**
+ * @param {StructStore} store
+ * @param {GC|Item} struct
+ *
+ * @private
+ * @function
+ */
+export const addStruct = (store, struct) => {
+  let structs = store.clients.get(struct.id.client)
+  if (structs === undefined) {
+    structs = []
+    store.clients.set(struct.id.client, structs)
+  } else {
+    const lastStruct = structs[structs.length - 1]
+    if (lastStruct.id.clock + lastStruct.length !== struct.id.clock) {
+      throw error.unexpectedCase()
+    }
+  }
+  structs.push(struct)
+}
+
+/**
+ * Perform a binary search on a sorted array
+ * @param {Array<any>} structs
+ * @param {number} clock
+ * @return {number}
+ *
+ * @private
+ * @function
+ */
+export const findIndexSS = (structs, clock) => {
+  let left = 0
+  let right = structs.length - 1
+  while (left <= right) {
+    const midindex = math.floor((left + right) / 2)
+    const mid = structs[midindex]
+    const midclock = mid.id.clock
+    if (midclock <= clock) {
+      if (clock < midclock + mid.length) {
+        return midindex
+      }
+      left = midindex + 1
+    } else {
+      right = midindex - 1
+    }
+  }
+  // Always check state before looking for a struct in StructStore
+  // Therefore the case of not finding a struct is unexpected
+  throw error.unexpectedCase()
+}
+
+/**
+ * Expects that id is actually in store. This function throws or is an infinite loop otherwise.
+ *
+ * @param {StructStore} store
+ * @param {ID} id
+ * @return {GC|Item}
+ *
+ * @private
+ * @function
+ */
+export const find = (store, id) => {
+  /**
+   * @type {Array<GC|Item>}
+   */
+  // @ts-ignore
+  const structs = store.clients.get(id.client)
+  return structs[findIndexSS(structs, id.clock)]
+}
+
+/**
+ * Expects that id is actually in store. This function throws or is an infinite loop otherwise.
+ *
+ * @param {StructStore} store
+ * @param {ID} id
+ * @return {Item}
+ *
+ * @private
+ * @function
+ */
+// @ts-ignore
+export const getItem = (store, id) => find(store, id)
+
+/**
+ * @param {Transaction} transaction
+ * @param {Array<Item|GC>} structs
+ * @param {number} clock
+ */
+export const findIndexCleanStart = (transaction, structs, clock) => {
+  const index = findIndexSS(structs, clock)
+  const struct = structs[index]
+  if (struct.id.clock < clock && struct instanceof Item) {
+    structs.splice(index + 1, 0, splitItem(transaction, struct, clock - struct.id.clock))
+    return index + 1
+  }
+  return index
+}
+
+/**
+ * Expects that id is actually in store. This function throws or is an infinite loop otherwise.
+ *
+ * @param {Transaction} transaction
+ * @param {ID} id
+ * @return {Item}
+ *
+ * @private
+ * @function
+ */
+export const getItemCleanStart = (transaction, id) => {
+  const structs = /** @type {Array<Item>} */ (transaction.doc.store.clients.get(id.client))
+  return structs[findIndexCleanStart(transaction, structs, id.clock)]
+}
+
+/**
+ * Expects that id is actually in store. This function throws or is an infinite loop otherwise.
+ *
+ * @param {Transaction} transaction
+ * @param {StructStore} store
+ * @param {ID} id
+ * @return {Item}
+ *
+ * @private
+ * @function
+ */
+export const getItemCleanEnd = (transaction, store, id) => {
+  /**
+   * @type {Array<Item>}
+   */
+  // @ts-ignore
+  const structs = store.clients.get(id.client)
+  const index = findIndexSS(structs, id.clock)
+  const struct = structs[index]
+  if (id.clock !== struct.id.clock + struct.length - 1 && struct.constructor !== GC) {
+    structs.splice(index + 1, 0, splitItem(transaction, struct, id.clock - struct.id.clock + 1))
+  }
+  return struct
+}
+
+/**
+ * Replace `item` with `newitem` in store
+ * @param {StructStore} store
+ * @param {GC|Item} struct
+ * @param {GC|Item} newStruct
+ *
+ * @private
+ * @function
+ */
+export const replaceStruct = (store, struct, newStruct) => {
+  const structs = /** @type {Array<GC|Item>} */ (store.clients.get(struct.id.client))
+  structs[findIndexSS(structs, struct.id.clock)] = newStruct
+}
+
+/**
+ * Iterate over a range of structs
+ *
+ * @param {Transaction} transaction
+ * @param {Array<Item|GC>} structs
+ * @param {number} clockStart Inclusive start
+ * @param {number} len
+ * @param {function(GC|Item):void} f
+ *
+ * @function
+ */
+export const iterateStructs = (transaction, structs, clockStart, len, f) => {
+  if (len === 0) {
+    return
+  }
+  const clockEnd = clockStart + len
+  let index = findIndexCleanStart(transaction, structs, clockStart)
+  let struct
+  do {
+    struct = structs[index++]
+    if (clockEnd < struct.id.clock + struct.length) {
+      findIndexCleanStart(transaction, structs, clockEnd)
+    }
+    f(struct)
+  } while (index < structs.length && structs[index].id.clock < clockEnd)
+}

src/utils/Transaction.js

@@ -0,0 +1,367 @@
+
+import {
+  getState,
+  createID,
+  writeStructsFromTransaction,
+  writeDeleteSet,
+  DeleteSet,
+  sortAndMergeDeleteSet,
+  getStateVector,
+  findIndexSS,
+  callEventHandlerListeners,
+  Item,
+  StructStore, ID, AbstractType, AbstractStruct, YEvent, Doc // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as map from 'lib0/map.js'
+import * as math from 'lib0/math.js'
+import * as set from 'lib0/set.js'
+import { callAll } from 'lib0/function.js'
+
+/**
+ * A transaction is created for every change on the Yjs model. It is possible
+ * to bundle changes on the Yjs model in a single transaction to
+ * minimize the number on messages sent and the number of observer calls.
+ * If possible the user of this library should bundle as many changes as
+ * possible. Here is an example to illustrate the advantages of bundling:
+ *
+ * @example
+ * const map = y.define('map', YMap)
+ * // Log content when change is triggered
+ * map.observe(() => {
+ *   console.log('change triggered')
+ * })
+ * // Each change on the map type triggers a log message:
+ * map.set('a', 0) // => "change triggered"
+ * map.set('b', 0) // => "change triggered"
+ * // When put in a transaction, it will trigger the log after the transaction:
+ * y.transact(() => {
+ *   map.set('a', 1)
+ *   map.set('b', 1)
+ * }) // => "change triggered"
+ *
+ * @public
+ */
+export class Transaction {
+  /**
+   * @param {Doc} doc
+   * @param {any} origin
+   * @param {boolean} local
+   */
+  constructor (doc, origin, local) {
+    /**
+     * The Yjs instance.
+     * @type {Doc}
+     */
+    this.doc = doc
+    /**
+     * Describes the set of deleted items by ids
+     * @type {DeleteSet}
+     */
+    this.deleteSet = new DeleteSet()
+    /**
+     * Holds the state before the transaction started.
+     * @type {Map<Number,Number>}
+     */
+    this.beforeState = getStateVector(doc.store)
+    /**
+     * Holds the state after the transaction.
+     * @type {Map<Number,Number>}
+     */
+    this.afterState = new Map()
+    /**
+     * 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)
+     * @type {Map<AbstractType<YEvent>,Set<String|null>>}
+     */
+    this.changed = new Map()
+    /**
+     * Stores the events for the types that observe also child elements.
+     * It is mainly used by `observeDeep`.
+     * @type {Map<AbstractType<YEvent>,Array<YEvent>>}
+     */
+    this.changedParentTypes = new Map()
+    /**
+     * @type {Set<ID>}
+     * @private
+     */
+    this._mergeStructs = new Set()
+    /**
+     * @type {any}
+     */
+    this.origin = origin
+    /**
+     * Stores meta information on the transaction
+     * @type {Map<any,any>}
+     */
+    this.meta = new Map()
+    /**
+     * Whether this change originates from this doc.
+     * @type {boolean}
+     */
+    this.local = local
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ */
+export const computeUpdateMessageFromTransaction = transaction => {
+  if (transaction.deleteSet.clients.size === 0 && !map.any(transaction.afterState, (clock, client) => transaction.beforeState.get(client) !== clock)) {
+    return null
+  }
+  const encoder = encoding.createEncoder()
+  sortAndMergeDeleteSet(transaction.deleteSet)
+  writeStructsFromTransaction(encoder, transaction)
+  writeDeleteSet(encoder, transaction.deleteSet)
+  return encoder
+}
+
+/**
+ * @param {Transaction} transaction
+ *
+ * @private
+ * @function
+ */
+export const nextID = transaction => {
+  const y = transaction.doc
+  return createID(y.clientID, getState(y.store, y.clientID))
+}
+
+/**
+ * If `type.parent` was added in current transaction, `type` technically
+ * did not change, it was just added and we should not fire events for `type`.
+ *
+ * @param {Transaction} transaction
+ * @param {AbstractType<YEvent>} type
+ * @param {string|null} parentSub
+ */
+export const addChangedTypeToTransaction = (transaction, type, parentSub) => {
+  const item = type._item
+  if (item === null || (item.id.clock < (transaction.beforeState.get(item.id.client) || 0) && !item.deleted)) {
+    map.setIfUndefined(transaction.changed, type, set.create).add(parentSub)
+  }
+}
+
+/**
+ * @param {Array<AbstractStruct>} structs
+ * @param {number} pos
+ */
+const tryToMergeWithLeft = (structs, pos) => {
+  const left = structs[pos - 1]
+  const right = structs[pos]
+  if (left.deleted === right.deleted && left.constructor === right.constructor) {
+    if (left.mergeWith(right)) {
+      structs.splice(pos, 1)
+      if (right instanceof Item && right.parentSub !== null && right.parent._map.get(right.parentSub) === right) {
+        right.parent._map.set(right.parentSub, /** @type {Item} */ (left))
+      }
+    }
+  }
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {StructStore} store
+ * @param {function(Item):boolean} gcFilter
+ */
+const tryGcDeleteSet = (ds, store, gcFilter) => {
+  for (const [client, deleteItems] of ds.clients) {
+    const structs = /** @type {Array<AbstractStruct>} */ (store.clients.get(client))
+    for (let di = deleteItems.length - 1; di >= 0; di--) {
+      const deleteItem = deleteItems[di]
+      const endDeleteItemClock = deleteItem.clock + deleteItem.len
+      for (
+        let si = findIndexSS(structs, deleteItem.clock), struct = structs[si];
+        si < structs.length && struct.id.clock < endDeleteItemClock;
+        struct = structs[++si]
+      ) {
+        const struct = structs[si]
+        if (deleteItem.clock + deleteItem.len <= struct.id.clock) {
+          break
+        }
+        if (struct instanceof Item && struct.deleted && !struct.keep && gcFilter(struct)) {
+          struct.gc(store, false)
+        }
+      }
+    }
+  }
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {StructStore} store
+ */
+const tryMergeDeleteSet = (ds, store) => {
+  // try to merge deleted / gc'd items
+  // merge from right to left for better efficiecy and so we don't miss any merge targets
+  for (const [client, deleteItems] of ds.clients) {
+    const structs = /** @type {Array<AbstractStruct>} */ (store.clients.get(client))
+    for (let di = deleteItems.length - 1; di >= 0; di--) {
+      const deleteItem = deleteItems[di]
+      // start with merging the item next to the last deleted item
+      const mostRightIndexToCheck = math.min(structs.length - 1, 1 + findIndexSS(structs, deleteItem.clock + deleteItem.len - 1))
+      for (
+        let si = mostRightIndexToCheck, struct = structs[si];
+        si > 0 && struct.id.clock >= deleteItem.clock;
+        struct = structs[--si]
+      ) {
+        tryToMergeWithLeft(structs, si)
+      }
+    }
+  }
+}
+
+/**
+ * @param {DeleteSet} ds
+ * @param {StructStore} store
+ * @param {function(Item):boolean} gcFilter
+ */
+export const tryGc = (ds, store, gcFilter) => {
+  tryGcDeleteSet(ds, store, gcFilter)
+  tryMergeDeleteSet(ds, store)
+}
+
+/**
+ * @param {Array<Transaction>} transactionCleanups
+ * @param {number} i
+ */
+const cleanupTransactions = (transactionCleanups, i) => {
+  if (i < transactionCleanups.length) {
+    const transaction = transactionCleanups[i]
+    const doc = transaction.doc
+    const store = doc.store
+    const ds = transaction.deleteSet
+    try {
+      sortAndMergeDeleteSet(ds)
+      transaction.afterState = getStateVector(transaction.doc.store)
+      doc._transaction = null
+      doc.emit('beforeObserverCalls', [transaction, doc])
+      /**
+       * An array of event callbacks.
+       *
+       * Each callback is called even if the other ones throw errors.
+       *
+       * @type {Array<function():void>}
+       */
+      const fs = []
+      // observe events on changed types
+      transaction.changed.forEach((subs, itemtype) =>
+        fs.push(() => {
+          if (itemtype._item === null || !itemtype._item.deleted) {
+            itemtype._callObserver(transaction, subs)
+          }
+        })
+      )
+      fs.push(() => {
+        // deep observe events
+        transaction.changedParentTypes.forEach((events, type) =>
+          fs.push(() => {
+            // We need to think about the possibility that the user transforms the
+            // Y.Doc in the event.
+            if (type._item === null || !type._item.deleted) {
+              events = events
+                .filter(event =>
+                  event.target._item === null || !event.target._item.deleted
+                )
+              events
+                .forEach(event => {
+                  event.currentTarget = type
+                })
+              // We don't need to check for events.length
+              // because we know it has at least one element
+              callEventHandlerListeners(type._dEH, events, transaction)
+            }
+          })
+        )
+        fs.push(() => doc.emit('afterTransaction', [transaction, doc]))
+      })
+      callAll(fs, [])
+    } finally {
+      // Replace deleted items with ItemDeleted / GC.
+      // This is where content is actually remove from the Yjs Doc.
+      if (doc.gc) {
+        tryGcDeleteSet(ds, store, doc.gcFilter)
+      }
+      tryMergeDeleteSet(ds, store)
+
+      // on all affected store.clients props, try to merge
+      for (const [client, clock] of transaction.afterState) {
+        const beforeClock = transaction.beforeState.get(client) || 0
+        if (beforeClock !== clock) {
+          const structs = /** @type {Array<AbstractStruct>} */ (store.clients.get(client))
+          // we iterate from right to left so we can safely remove entries
+          const firstChangePos = math.max(findIndexSS(structs, beforeClock), 1)
+          for (let i = structs.length - 1; i >= firstChangePos; i--) {
+            tryToMergeWithLeft(structs, i)
+          }
+        }
+      }
+      // try to merge mergeStructs
+      // @todo: it makes more sense to transform mergeStructs to a DS, sort it, and merge from right to left
+      //        but at the moment DS does not handle duplicates
+      for (const mid of transaction._mergeStructs) {
+        const client = mid.client
+        const clock = mid.clock
+        const structs = /** @type {Array<AbstractStruct>} */ (store.clients.get(client))
+        const replacedStructPos = findIndexSS(structs, clock)
+        if (replacedStructPos + 1 < structs.length) {
+          tryToMergeWithLeft(structs, replacedStructPos + 1)
+        }
+        if (replacedStructPos > 0) {
+          tryToMergeWithLeft(structs, replacedStructPos)
+        }
+      }
+      // @todo Merge all the transactions into one and provide send the data as a single update message
+      doc.emit('afterTransactionCleanup', [transaction, doc])
+      if (doc._observers.has('update')) {
+        const updateMessage = computeUpdateMessageFromTransaction(transaction)
+        if (updateMessage !== null) {
+          doc.emit('update', [encoding.toUint8Array(updateMessage), transaction.origin, doc])
+        }
+      }
+      if (transactionCleanups.length <= i + 1) {
+        doc._transactionCleanups = []
+      } else {
+        cleanupTransactions(transactionCleanups, i + 1)
+      }
+    }
+  }
+}
+
+/**
+ * Implements the functionality of `y.transact(()=>{..})`
+ *
+ * @param {Doc} doc
+ * @param {function(Transaction):void} f
+ * @param {any} [origin=true]
+ *
+ * @function
+ */
+export const transact = (doc, f, origin = null, local = true) => {
+  const transactionCleanups = doc._transactionCleanups
+  let initialCall = false
+  if (doc._transaction === null) {
+    initialCall = true
+    doc._transaction = new Transaction(doc, origin, local)
+    transactionCleanups.push(doc._transaction)
+    doc.emit('beforeTransaction', [doc._transaction, doc])
+  }
+  try {
+    f(doc._transaction)
+  } finally {
+    if (initialCall && transactionCleanups[0] === doc._transaction) {
+      // The first transaction ended, now process observer calls.
+      // Observer call may create new transactions for which we need to call the observers and do cleanup.
+      // We don't want to nest these calls, so we execute these calls one after
+      // another.
+      // Also we need to ensure that all cleanups are called, even if the
+      // observes throw errors.
+      // This file is full of hacky try {} finally {} blocks to ensure that an
+      // event can throw errors and also that the cleanup is called.
+      cleanupTransactions(transactionCleanups, 0)
+    }
+  }
+}

src/utils/UndoManager.js

@@ -0,0 +1,283 @@
+import {
+  mergeDeleteSets,
+  iterateDeletedStructs,
+  keepItem,
+  transact,
+  redoItem,
+  iterateStructs,
+  isParentOf,
+  createID,
+  followRedone,
+  getItemCleanStart,
+  getState,
+  Transaction, Doc, Item, GC, DeleteSet, AbstractType // eslint-disable-line
+} from '../internals.js'
+
+import * as time from 'lib0/time.js'
+import { Observable } from 'lib0/observable.js'
+
+class StackItem {
+  /**
+   * @param {DeleteSet} ds
+   * @param {number} start clock start of the local client
+   * @param {number} len
+   */
+  constructor (ds, start, len) {
+    this.ds = ds
+    this.start = start
+    this.len = len
+    /**
+     * Use this to save and restore metadata like selection range
+     */
+    this.meta = new Map()
+  }
+}
+
+/**
+ * @param {UndoManager} undoManager
+ * @param {Array<StackItem>} stack
+ * @param {string} eventType
+ * @return {StackItem?}
+ */
+const popStackItem = (undoManager, stack, eventType) => {
+  /**
+   * Whether a change happened
+   * @type {StackItem?}
+   */
+  let result = null
+  const doc = undoManager.doc
+  const scope = undoManager.scope
+  transact(doc, transaction => {
+    while (stack.length > 0 && result === null) {
+      const store = doc.store
+      const clientID = doc.clientID
+      const stackItem = /** @type {StackItem} */ (stack.pop())
+      const stackStartClock = stackItem.start
+      const stackEndClock = stackItem.start + stackItem.len
+      const itemsToRedo = new Set()
+      // @todo iterateStructs should not need the structs parameter
+      const structs = /** @type {Array<GC|Item>} */ (store.clients.get(clientID))
+      let performedChange = false
+      if (stackStartClock !== stackEndClock) {
+        // make sure structs don't overlap with the range of created operations [stackItem.start, stackItem.start + stackItem.end)
+        getItemCleanStart(transaction, createID(clientID, stackStartClock))
+        if (stackEndClock < getState(doc.store, clientID)) {
+          getItemCleanStart(transaction, createID(clientID, stackEndClock))
+        }
+      }
+      iterateDeletedStructs(transaction, stackItem.ds, struct => {
+        if (
+          struct instanceof Item &&
+          scope.some(type => isParentOf(type, struct)) &&
+          // Never redo structs in [stackItem.start, stackItem.start + stackItem.end) because they were created and deleted in the same capture interval.
+          !(struct.id.client === clientID && struct.id.clock >= stackStartClock && struct.id.clock < stackEndClock)
+        ) {
+          itemsToRedo.add(struct)
+        }
+      })
+      itemsToRedo.forEach(struct => {
+        performedChange = redoItem(transaction, struct, itemsToRedo) !== null || performedChange
+      })
+      /**
+       * @type {Array<Item>}
+       */
+      const itemsToDelete = []
+      iterateStructs(transaction, structs, stackStartClock, stackItem.len, struct => {
+        if (struct instanceof Item) {
+          if (struct.redone !== null) {
+            let { item, diff } = followRedone(store, struct.id)
+            if (diff > 0) {
+              item = getItemCleanStart(transaction, createID(item.id.client, item.id.clock + diff))
+            }
+            if (item.length > stackItem.len) {
+              getItemCleanStart(transaction, createID(item.id.client, stackEndClock))
+            }
+            struct = item
+          }
+          if (!struct.deleted && scope.some(type => isParentOf(type, /** @type {Item} */ (struct)))) {
+            itemsToDelete.push(struct)
+          }
+        }
+      })
+      // We want to delete in reverse order so that children are deleted before
+      // parents, so we have more information available when items are filtered.
+      for (let i = itemsToDelete.length - 1; i >= 0; i--) {
+        const item = itemsToDelete[i]
+        if (undoManager.deleteFilter(item)) {
+          item.delete(transaction)
+          performedChange = true
+        }
+      }
+      result = stackItem
+      if (result != null) {
+        undoManager.emit('stack-item-popped', [{ stackItem: result, type: eventType }, undoManager])
+      }
+    }
+  }, undoManager)
+  return result
+}
+
+/**
+ * @typedef {Object} UndoManagerOptions
+ * @property {number} [UndoManagerOptions.captureTimeout=500]
+ * @property {function(Item):boolean} [UndoManagerOptions.deleteFilter=()=>true] Sometimes
+ * it is necessary to filter whan an Undo/Redo operation can delete. If this
+ * filter returns false, the type/item won't be deleted even it is in the
+ * undo/redo scope.
+ * @property {Set<any>} [UndoManagerOptions.trackedOrigins=new Set([null])]
+ */
+
+/**
+ * Fires 'stack-item-added' event when a stack item was added to either the undo- or
+ * the redo-stack. You may store additional stack information via the
+ * metadata property on `event.stackItem.meta` (it is a `Map` of metadata properties).
+ * Fires 'stack-item-popped' event when a stack item was popped from either the
+ * undo- or the redo-stack. You may restore the saved stack information from `event.stackItem.meta`.
+ *
+ * @extends {Observable<'stack-item-added'|'stack-item-popped'>}
+ */
+export class UndoManager extends Observable {
+  /**
+   * @param {AbstractType<any>|Array<AbstractType<any>>} typeScope Accepts either a single type, or an array of types
+   * @param {UndoManagerOptions} options
+   */
+  constructor (typeScope, { captureTimeout, deleteFilter = () => true, trackedOrigins = new Set([null]) } = {}) {
+    if (captureTimeout == null) {
+      captureTimeout = 500
+    }
+    super()
+    this.scope = typeScope instanceof Array ? typeScope : [typeScope]
+    this.deleteFilter = deleteFilter
+    trackedOrigins.add(this)
+    this.trackedOrigins = trackedOrigins
+    /**
+     * @type {Array<StackItem>}
+     */
+    this.undoStack = []
+    /**
+     * @type {Array<StackItem>}
+     */
+    this.redoStack = []
+    /**
+     * Whether the client is currently undoing (calling UndoManager.undo)
+     *
+     * @type {boolean}
+     */
+    this.undoing = false
+    this.redoing = false
+    this.doc = /** @type {Doc} */ (this.scope[0].doc)
+    this.lastChange = 0
+    this.doc.on('afterTransaction', /** @param {Transaction} transaction */ transaction => {
+      // Only track certain transactions
+      if (!this.scope.some(type => transaction.changedParentTypes.has(type)) || (!this.trackedOrigins.has(transaction.origin) && (!transaction.origin || !this.trackedOrigins.has(transaction.origin.constructor)))) {
+        return
+      }
+      const undoing = this.undoing
+      const redoing = this.redoing
+      const stack = undoing ? this.redoStack : this.undoStack
+      if (undoing) {
+        this.stopCapturing() // next undo should not be appended to last stack item
+      } else if (!redoing) {
+        // neither undoing nor redoing: delete redoStack
+        this.redoStack = []
+      }
+      const beforeState = transaction.beforeState.get(this.doc.clientID) || 0
+      const afterState = transaction.afterState.get(this.doc.clientID) || 0
+      const now = time.getUnixTime()
+      if (now - this.lastChange < captureTimeout && stack.length > 0 && !undoing && !redoing) {
+        // append change to last stack op
+        const lastOp = stack[stack.length - 1]
+        lastOp.ds = mergeDeleteSets([lastOp.ds, transaction.deleteSet])
+        lastOp.len = afterState - lastOp.start
+      } else {
+        // create a new stack op
+        stack.push(new StackItem(transaction.deleteSet, beforeState, afterState - beforeState))
+      }
+      if (!undoing && !redoing) {
+        this.lastChange = now
+      }
+      // make sure that deleted structs are not gc'd
+      iterateDeletedStructs(transaction, transaction.deleteSet, /** @param {Item|GC} item */ item => {
+        if (item instanceof Item && this.scope.some(type => isParentOf(type, item))) {
+          keepItem(item, true)
+        }
+      })
+      this.emit('stack-item-added', [{ stackItem: stack[stack.length - 1], origin: transaction.origin, type: undoing ? 'redo' : 'undo' }, this])
+    })
+  }
+
+  clear () {
+    this.doc.transact(transaction => {
+      /**
+       * @param {StackItem} stackItem
+       */
+      const clearItem = stackItem => {
+        iterateDeletedStructs(transaction, stackItem.ds, item => {
+          if (item instanceof Item && this.scope.some(type => isParentOf(type, item))) {
+            keepItem(item, false)
+          }
+        })
+      }
+      this.undoStack.forEach(clearItem)
+      this.redoStack.forEach(clearItem)
+    })
+    this.undoStack = []
+    this.redoStack = []
+  }
+
+  /**
+   * UndoManager merges Undo-StackItem if they are created within time-gap
+   * smaller than `options.captureTimeout`. Call `um.stopCapturing()` so that the next
+   * StackItem won't be merged.
+   *
+   *
+   * @example
+   *     // without stopCapturing
+   *     ytext.insert(0, 'a')
+   *     ytext.insert(1, 'b')
+   *     um.undo()
+   *     ytext.toString() // => '' (note that 'ab' was removed)
+   *     // with stopCapturing
+   *     ytext.insert(0, 'a')
+   *     um.stopCapturing()
+   *     ytext.insert(0, 'b')
+   *     um.undo()
+   *     ytext.toString() // => 'a' (note that only 'b' was removed)
+   *
+   */
+  stopCapturing () {
+    this.lastChange = 0
+  }
+
+  /**
+   * Undo last changes on type.
+   *
+   * @return {StackItem?} Returns StackItem if a change was applied
+   */
+  undo () {
+    this.undoing = true
+    let res
+    try {
+      res = popStackItem(this, this.undoStack, 'undo')
+    } finally {
+      this.undoing = false
+    }
+    return res
+  }
+
+  /**
+   * Redo last undo operation.
+   *
+   * @return {StackItem?} Returns StackItem if a change was applied
+   */
+  redo () {
+    this.redoing = true
+    let res
+    try {
+      res = popStackItem(this, this.redoStack, 'redo')
+    } finally {
+      this.redoing = false
+    }
+    return res
+  }
+}

src/utils/YEvent.js

@@ -0,0 +1,226 @@
+
+import {
+  isDeleted,
+  Item, AbstractType, Transaction, AbstractStruct // eslint-disable-line
+} from '../internals.js'
+
+import * as set from 'lib0/set.js'
+import * as array from 'lib0/array.js'
+
+/**
+ * YEvent describes the changes on a YType.
+ */
+export class YEvent {
+  /**
+   * @param {AbstractType<any>} target The changed type.
+   * @param {Transaction} transaction
+   */
+  constructor (target, transaction) {
+    /**
+     * The type on which this event was created on.
+     * @type {AbstractType<any>}
+     */
+    this.target = target
+    /**
+     * The current target on which the observe callback is called.
+     * @type {AbstractType<any>}
+     */
+    this.currentTarget = target
+    /**
+     * The transaction that triggered this event.
+     * @type {Transaction}
+     */
+    this.transaction = transaction
+    /**
+     * @type {Object|null}
+     */
+    this._changes = null
+  }
+
+  /**
+   * Computes the path from `y` to the changed type.
+   *
+   * The following property holds:
+   * @example
+   *   let type = y
+   *   event.path.forEach(dir => {
+   *     type = type.get(dir)
+   *   })
+   *   type === event.target // => true
+   */
+  get path () {
+    // @ts-ignore _item is defined because target is integrated
+    return getPathTo(this.currentTarget, this.target)
+  }
+
+  /**
+   * Check if a struct is deleted by this event.
+   *
+   * In contrast to change.deleted, this method also returns true if the struct was added and then deleted.
+   *
+   * @param {AbstractStruct} struct
+   * @return {boolean}
+   */
+  deletes (struct) {
+    return isDeleted(this.transaction.deleteSet, struct.id)
+  }
+
+  /**
+   * Check if a struct is added by this event.
+   *
+   * In contrast to change.deleted, this method also returns true if the struct was added and then deleted.
+   *
+   * @param {AbstractStruct} struct
+   * @return {boolean}
+   */
+  adds (struct) {
+    return struct.id.clock >= (this.transaction.beforeState.get(struct.id.client) || 0)
+  }
+
+  /**
+   * @return {{added:Set<Item>,deleted:Set<Item>,delta:Array<{insert:Array<any>}|{delete:number}|{retain:number}>}}
+   */
+  get changes () {
+    let changes = this._changes
+    if (changes === null) {
+      const target = this.target
+      const added = set.create()
+      const deleted = set.create()
+      /**
+       * @type {Array<{insert:Array<any>}|{delete:number}|{retain:number}>}
+       */
+      const delta = []
+      /**
+       * @type {Map<string,{ action: 'add' | 'update' | 'delete', oldValue: any}>}
+       */
+      const keys = new Map()
+      changes = {
+        added, deleted, delta, keys
+      }
+      const changed = /** @type Set<string|null> */ (this.transaction.changed.get(target))
+      if (changed.has(null)) {
+        /**
+         * @type {any}
+         */
+        let lastOp = null
+        const packOp = () => {
+          if (lastOp) {
+            delta.push(lastOp)
+          }
+        }
+        for (let item = target._start; item !== null; item = item.right) {
+          if (item.deleted) {
+            if (this.deletes(item) && !this.adds(item)) {
+              if (lastOp === null || lastOp.delete === undefined) {
+                packOp()
+                lastOp = { delete: 0 }
+              }
+              lastOp.delete += item.length
+              deleted.add(item)
+            } // else nop
+          } else {
+            if (this.adds(item)) {
+              if (lastOp === null || lastOp.insert === undefined) {
+                packOp()
+                lastOp = { insert: [] }
+              }
+              lastOp.insert = lastOp.insert.concat(item.content.getContent())
+              added.add(item)
+            } else {
+              if (lastOp === null || lastOp.retain === undefined) {
+                packOp()
+                lastOp = { retain: 0 }
+              }
+              lastOp.retain += item.length
+            }
+          }
+        }
+        if (lastOp !== null && lastOp.retain === undefined) {
+          packOp()
+        }
+      }
+      changed.forEach(key => {
+        if (key !== null) {
+          const item = /** @type {Item} */ (target._map.get(key))
+          /**
+           * @type {'delete' | 'add' | 'update'}
+           */
+          let action
+          let oldValue
+          if (this.adds(item)) {
+            let prev = item.left
+            while (prev !== null && this.adds(prev)) {
+              prev = prev.left
+            }
+            if (this.deletes(item)) {
+              if (prev !== null && this.deletes(prev)) {
+                action = 'delete'
+                oldValue = array.last(prev.content.getContent())
+              } else {
+                return
+              }
+            } else {
+              if (prev !== null && this.deletes(prev)) {
+                action = 'update'
+                oldValue = array.last(prev.content.getContent())
+              } else {
+                action = 'add'
+                oldValue = undefined
+              }
+            }
+          } else {
+            if (this.deletes(item)) {
+              action = 'delete'
+              oldValue = array.last(/** @type {Item} */ item.content.getContent())
+            } else {
+              return // nop
+            }
+          }
+          keys.set(key, { action, oldValue })
+        }
+      })
+      this._changes = changes
+    }
+    return /** @type {any} */ (changes)
+  }
+}
+
+/**
+ * Compute the path from this type to the specified target.
+ *
+ * @example
+ *   // `child` should be accessible via `type.get(path[0]).get(path[1])..`
+ *   const path = type.getPathTo(child)
+ *   // assuming `type instanceof YArray`
+ *   console.log(path) // might look like => [2, 'key1']
+ *   child === type.get(path[0]).get(path[1])
+ *
+ * @param {AbstractType<any>} parent
+ * @param {AbstractType<any>} child target
+ * @return {Array<string|number>} Path to the target
+ *
+ * @private
+ * @function
+ */
+const getPathTo = (parent, child) => {
+  const path = []
+  while (child._item !== null && child !== parent) {
+    if (child._item.parentSub !== null) {
+      // parent is map-ish
+      path.unshift(child._item.parentSub)
+    } else {
+      // parent is array-ish
+      let i = 0
+      let c = child._item.parent._start
+      while (c !== child._item && c !== null) {
+        if (!c.deleted) {
+          i++
+        }
+        c = c.right
+      }
+      path.unshift(i)
+    }
+    child = child._item.parent
+  }
+  return path
+}

src/utils/encoding.js

@@ -0,0 +1,423 @@
+
+/**
+ * @module encoding
+ *
+ * We use the first five bits in the info flag for determining the type of the struct.
+ *
+ * 0: GC
+ * 1: Item with Deleted content
+ * 2: Item with JSON content
+ * 3: Item with Binary content
+ * 4: Item with String content
+ * 5: Item with Embed content (for richtext content)
+ * 6: Item with Format content (a formatting marker for richtext content)
+ * 7: Item with Type
+ */
+
+import {
+  findIndexSS,
+  GCRef,
+  ItemRef,
+  writeID,
+  createID,
+  readID,
+  getState,
+  getStateVector,
+  readAndApplyDeleteSet,
+  writeDeleteSet,
+  createDeleteSetFromStructStore,
+  transact,
+  Doc, Transaction, AbstractStruct, StructStore, ID // eslint-disable-line
+} from '../internals.js'
+
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as binary from 'lib0/binary.js'
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {Array<AbstractStruct>} structs All structs by `client`
+ * @param {number} client
+ * @param {number} clock write structs starting with `ID(client,clock)`
+ *
+ * @function
+ */
+const writeStructs = (encoder, structs, client, clock) => {
+  // write first id
+  const startNewStructs = findIndexSS(structs, clock)
+  // write # encoded structs
+  encoding.writeVarUint(encoder, structs.length - startNewStructs)
+  writeID(encoder, createID(client, clock))
+  const firstStruct = structs[startNewStructs]
+  // write first struct with an offset
+  firstStruct.write(encoder, clock - firstStruct.id.clock, 0)
+  for (let i = startNewStructs + 1; i < structs.length; i++) {
+    structs[i].write(encoder, 0, 0)
+  }
+}
+
+/**
+ * @param {decoding.Decoder} decoder
+ * @param {number} numOfStructs
+ * @param {ID} nextID
+ * @return {Array<GCRef|ItemRef>}
+ *
+ * @private
+ * @function
+ */
+const readStructRefs = (decoder, numOfStructs, nextID) => {
+  /**
+   * @type {Array<GCRef|ItemRef>}
+   */
+  const refs = []
+  for (let i = 0; i < numOfStructs; i++) {
+    const info = decoding.readUint8(decoder)
+    const ref = (binary.BITS5 & info) === 0 ? new GCRef(decoder, nextID, info) : new ItemRef(decoder, nextID, info)
+    nextID = createID(nextID.client, nextID.clock + ref.length)
+    refs.push(ref)
+  }
+  return refs
+}
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {StructStore} store
+ * @param {Map<number,number>} _sm
+ *
+ * @private
+ * @function
+ */
+export const writeClientsStructs = (encoder, store, _sm) => {
+  // we filter all valid _sm entries into sm
+  const sm = new Map()
+  _sm.forEach((clock, client) => {
+    // only write if new structs are available
+    if (getState(store, client) > clock) {
+      sm.set(client, clock)
+    }
+  })
+  getStateVector(store).forEach((clock, client) => {
+    if (!_sm.has(client)) {
+      sm.set(client, 0)
+    }
+  })
+  // write # states that were updated
+  encoding.writeVarUint(encoder, sm.size)
+  sm.forEach((clock, client) => {
+    // @ts-ignore
+    writeStructs(encoder, store.clients.get(client), client, clock)
+  })
+}
+
+/**
+ * @param {decoding.Decoder} decoder The decoder object to read data from.
+ * @return {Map<number,Array<GCRef|ItemRef>>}
+ *
+ * @private
+ * @function
+ */
+export const readClientsStructRefs = decoder => {
+  /**
+   * @type {Map<number,Array<GCRef|ItemRef>>}
+   */
+  const clientRefs = new Map()
+  const numOfStateUpdates = decoding.readVarUint(decoder)
+  for (let i = 0; i < numOfStateUpdates; i++) {
+    const numberOfStructs = decoding.readVarUint(decoder)
+    const nextID = readID(decoder)
+    const refs = readStructRefs(decoder, numberOfStructs, nextID)
+    clientRefs.set(nextID.client, refs)
+  }
+  return clientRefs
+}
+
+/**
+ * Resume computing structs generated by struct readers.
+ *
+ * While there is something to do, we integrate structs in this order
+ * 1. top element on stack, if stack is not empty
+ * 2. next element from current struct reader (if empty, use next struct reader)
+ *
+ * If struct causally depends on another struct (ref.missing), we put next reader of
+ * `ref.id.client` on top of stack.
+ *
+ * At some point we find a struct that has no causal dependencies,
+ * then we start emptying the stack.
+ *
+ * It is not possible to have circles: i.e. struct1 (from client1) depends on struct2 (from client2)
+ * depends on struct3 (from client1). Therefore the max stack size is eqaul to `structReaders.length`.
+ *
+ * This method is implemented in a way so that we can resume computation if this update
+ * causally depends on another update.
+ *
+ * @param {Transaction} transaction
+ * @param {StructStore} store
+ *
+ * @private
+ * @function
+ */
+const resumeStructIntegration = (transaction, store) => {
+  const stack = store.pendingStack
+  const clientsStructRefs = store.pendingClientsStructRefs
+  // iterate over all struct readers until we are done
+  while (stack.length !== 0 || clientsStructRefs.size !== 0) {
+    if (stack.length === 0) {
+      // take any first struct from clientsStructRefs and put it on the stack
+      const [client, structRefs] = clientsStructRefs.entries().next().value
+      stack.push(structRefs.refs[structRefs.i++])
+      if (structRefs.refs.length === structRefs.i) {
+        clientsStructRefs.delete(client)
+      }
+    }
+    const ref = stack[stack.length - 1]
+    const m = ref._missing
+    const client = ref.id.client
+    const localClock = getState(store, client)
+    const offset = ref.id.clock < localClock ? localClock - ref.id.clock : 0
+    if (ref.id.clock + offset !== localClock) {
+      // A previous message from this client is missing
+      // check if there is a pending structRef with a smaller clock and switch them
+      const structRefs = clientsStructRefs.get(client)
+      if (structRefs !== undefined) {
+        const r = structRefs.refs[structRefs.i]
+        if (r.id.clock < ref.id.clock) {
+          // put ref with smaller clock on stack instead and continue
+          structRefs.refs[structRefs.i] = ref
+          stack[stack.length - 1] = r
+          // sort the set because this approach might bring the list out of order
+          structRefs.refs = structRefs.refs.slice(structRefs.i).sort((r1, r2) => r1.id.clock - r2.id.clock)
+          structRefs.i = 0
+          continue
+        }
+      }
+      // wait until missing struct is available
+      return
+    }
+    while (m.length > 0) {
+      const missing = m[m.length - 1]
+      if (getState(store, missing.client) <= missing.clock) {
+        const client = missing.client
+        // get the struct reader that has the missing struct
+        const structRefs = clientsStructRefs.get(client)
+        if (structRefs === undefined) {
+          // This update message causally depends on another update message.
+          return
+        }
+        stack.push(structRefs.refs[structRefs.i++])
+        if (structRefs.i === structRefs.refs.length) {
+          clientsStructRefs.delete(client)
+        }
+        break
+      }
+      ref._missing.pop()
+    }
+    if (m.length === 0) {
+      if (offset < ref.length) {
+        ref.toStruct(transaction, store, offset).integrate(transaction)
+      }
+      stack.pop()
+    }
+  }
+}
+
+/**
+ * @param {Transaction} transaction
+ * @param {StructStore} store
+ *
+ * @private
+ * @function
+ */
+export const tryResumePendingDeleteReaders = (transaction, store) => {
+  const pendingReaders = store.pendingDeleteReaders
+  store.pendingDeleteReaders = []
+  for (let i = 0; i < pendingReaders.length; i++) {
+    readAndApplyDeleteSet(pendingReaders[i], transaction, store)
+  }
+}
+
+/**
+ * @param {encoding.Encoder} encoder
+ * @param {Transaction} transaction
+ *
+ * @private
+ * @function
+ */
+export const writeStructsFromTransaction = (encoder, transaction) => writeClientsStructs(encoder, transaction.doc.store, transaction.beforeState)
+
+/**
+ * @param {StructStore} store
+ * @param {Map<number, Array<GCRef|ItemRef>>} clientsStructsRefs
+ *
+ * @private
+ * @function
+ */
+const mergeReadStructsIntoPendingReads = (store, clientsStructsRefs) => {
+  const pendingClientsStructRefs = store.pendingClientsStructRefs
+  for (const [client, structRefs] of clientsStructsRefs) {
+    const pendingStructRefs = pendingClientsStructRefs.get(client)
+    if (pendingStructRefs === undefined) {
+      pendingClientsStructRefs.set(client, { refs: structRefs, i: 0 })
+    } else {
+      // merge into existing structRefs
+      const merged = pendingStructRefs.i > 0 ? pendingStructRefs.refs.slice(pendingStructRefs.i) : pendingStructRefs.refs
+      for (let i = 0; i < structRefs.length; i++) {
+        merged.push(structRefs[i])
+      }
+      pendingStructRefs.i = 0
+      pendingStructRefs.refs = merged.sort((r1, r2) => r1.id.clock - r2.id.clock)
+    }
+  }
+}
+
+/**
+ * Read the next Item in a Decoder and fill this Item with the read data.
+ *
+ * This is called when data is received from a remote peer.
+ *
+ * @param {decoding.Decoder} decoder The decoder object to read data from.
+ * @param {Transaction} transaction
+ * @param {StructStore} store
+ *
+ * @private
+ * @function
+ */
+export const readStructs = (decoder, transaction, store) => {
+  const clientsStructRefs = readClientsStructRefs(decoder)
+  mergeReadStructsIntoPendingReads(store, clientsStructRefs)
+  resumeStructIntegration(transaction, store)
+  tryResumePendingDeleteReaders(transaction, store)
+}
+
+/**
+ * Read and apply a document update.
+ *
+ * This function has the same effect as `applyUpdate` but accepts an decoder.
+ *
+ * @param {decoding.Decoder} decoder
+ * @param {Doc} ydoc
+ * @param {any} [transactionOrigin] This will be stored on `transaction.origin` and `.on('update', (update, origin))`
+ *
+ * @function
+ */
+export const readUpdate = (decoder, ydoc, transactionOrigin) =>
+  transact(ydoc, transaction => {
+    readStructs(decoder, transaction, ydoc.store)
+    readAndApplyDeleteSet(decoder, transaction, ydoc.store)
+  }, transactionOrigin, false)
+
+/**
+ * Apply a document update created by, for example, `y.on('update', update => ..)` or `update = encodeStateAsUpdate()`.
+ *
+ * This function has the same effect as `readUpdate` but accepts an Uint8Array instead of a Decoder.
+ *
+ * @param {Doc} ydoc
+ * @param {Uint8Array} update
+ * @param {any} [transactionOrigin] This will be stored on `transaction.origin` and `.on('update', (update, origin))`
+ *
+ * @function
+ */
+export const applyUpdate = (ydoc, update, transactionOrigin) =>
+  readUpdate(decoding.createDecoder(update), ydoc, transactionOrigin)
+
+/**
+ * Write all the document as a single update message. If you specify the state of the remote client (`targetStateVector`) it will
+ * only write the operations that are missing.
+ *
+ * @param {encoding.Encoder} encoder
+ * @param {Doc} doc
+ * @param {Map<number,number>} [targetStateVector] The state of the target that receives the update. Leave empty to write all known structs
+ *
+ * @function
+ */
+export const writeStateAsUpdate = (encoder, doc, targetStateVector = new Map()) => {
+  writeClientsStructs(encoder, doc.store, targetStateVector)
+  writeDeleteSet(encoder, createDeleteSetFromStructStore(doc.store))
+}
+
+/**
+ * Write all the document as a single update message that can be applied on the remote document. If you specify the state of the remote client (`targetState`) it will
+ * only write the operations that are missing.
+ *
+ * Use `writeStateAsUpdate` instead if you are working with lib0/encoding.js#Encoder
+ *
+ * @param {Doc} doc
+ * @param {Uint8Array} [encodedTargetStateVector] The state of the target that receives the update. Leave empty to write all known structs
+ * @return {Uint8Array}
+ *
+ * @function
+ */
+export const encodeStateAsUpdate = (doc, encodedTargetStateVector) => {
+  const encoder = encoding.createEncoder()
+  const targetStateVector = encodedTargetStateVector == null ? new Map() : decodeStateVector(encodedTargetStateVector)
+  writeStateAsUpdate(encoder, doc, targetStateVector)
+  return encoding.toUint8Array(encoder)
+}
+
+/**
+ * Read state vector from Decoder and return as Map
+ *
+ * @param {decoding.Decoder} decoder
+ * @return {Map<number,number>} Maps `client` to the number next expected `clock` from that client.
+ *
+ * @function
+ */
+export const readStateVector = decoder => {
+  const ss = new Map()
+  const ssLength = decoding.readVarUint(decoder)
+  for (let i = 0; i < ssLength; i++) {
+    const client = decoding.readVarUint(decoder)
+    const clock = decoding.readVarUint(decoder)
+    ss.set(client, clock)
+  }
+  return ss
+}
+
+/**
+ * Read decodedState and return State as Map.
+ *
+ * @param {Uint8Array} decodedState
+ * @return {Map<number,number>} Maps `client` to the number next expected `clock` from that client.
+ *
+ * @function
+ */
+export const decodeStateVector = decodedState => readStateVector(decoding.createDecoder(decodedState))
+
+/**
+ * Write State Vector to `lib0/encoding.js#Encoder`.
+ *
+ * @param {encoding.Encoder} encoder
+ * @param {Map<number,number>} sv
+ * @function
+ */
+export const writeStateVector = (encoder, sv) => {
+  encoding.writeVarUint(encoder, sv.size)
+  sv.forEach((clock, client) => {
+    encoding.writeVarUint(encoder, client)
+    encoding.writeVarUint(encoder, clock)
+  })
+  return encoder
+}
+
+/**
+ * Write State Vector to `lib0/encoding.js#Encoder`.
+ *
+ * @param {encoding.Encoder} encoder
+ * @param {Doc} doc
+ *
+ * @function
+ */
+export const writeDocumentStateVector = (encoder, doc) => writeStateVector(encoder, getStateVector(doc.store))
+
+/**
+ * Encode State as Uint8Array.
+ *
+ * @param {Doc} doc
+ * @return {Uint8Array}
+ *
+ * @function
+ */
+export const encodeStateVector = doc => {
+  const encoder = encoding.createEncoder()
+  writeDocumentStateVector(encoder, doc)
+  return encoding.toUint8Array(encoder)
+}

src/utils/isParentOf.js

@@ -0,0 +1,22 @@
+
+import { AbstractType, Item } from '../internals.js' // eslint-disable-line
+
+/**
+ * Check if `parent` is a parent of `child`.
+ *
+ * @param {AbstractType<any>} parent
+ * @param {Item|null} child
+ * @return {Boolean} Whether `parent` is a parent of `child`.
+ *
+ * @private
+ * @function
+ */
+export const isParentOf = (parent, child) => {
+  while (child !== null) {
+    if (child.parent === parent) {
+      return true
+    }
+    child = child.parent._item
+  }
+  return false
+}

test.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Testing Yjs</title>
+</head>
+<body>
+  <script type="module" src="./dist/tests.js"></script>
+</body>
+</html>

test/Json_test.coffee

@@ -1,274 +0,0 @@
-chai      = require('chai')
-expect    = chai.expect
-should    = chai.should()
-sinon     = require('sinon')
-sinonChai = require('sinon-chai')
-_         = require("underscore")
-
-chai.use(sinonChai)
-
-Connector = require "../../y-test/lib/y-test.coffee"
-Y = require "../lib/y.coffee"
-
-Test = require "./TestSuite"
-
-class JsonTest extends Test
-  makeNewUser: (userId)->
-    conn = new Connector userId
-    super new Y conn
-
-  type: "JsonTest"
-
-  getRandomRoot: (user_num, root)->
-    root ?= @users[user_num]
-    types = @users[user_num].types
-    if _.random(0,1) is 1 # take root
-      root
-    else # take child
-      elems = null
-      if root.type is "Object"
-        elems =
-          for oname,val of root.val()
-            val
-      else if root.type is "Array"
-        elems = root.val()
-      else
-        return root
-
-      elems = elems.filter (elem)->
-        (elem.type is "Array") or (elem.type is "Object")
-      if elems.length is 0
-        root
-      else
-        p = elems[_.random(0, elems.length-1)]
-        @getRandomRoot user_num, p
-
-
-  getContent: (user_num)->
-    @users[user_num].toJson(true)
-
-  getGeneratingFunctions: (user_num)->
-    types = @users[user_num].types
-    super(user_num).concat [
-        f : (y)=> # SET PROPERTY
-          l = y.val().length
-          y.val(_.random(0, l-1), @getRandomText(), 'immutable')
-          null
-        types : [types.Array]
-      , f : (y)=> # Delete Array Element
-          list = y.val()
-          if list.length > 0
-            key = list[_random(0,list.length-1)]
-            y.delete(key)
-        types: [types.Array]
-      , f : (y)=> # insert TEXT mutable
-          l = y.val().length
-          y.val(_.random(0, l-1), @getRamdomObject())
-        types: [types.Array]
-      , f : (y)=> # insert string
-          l = y.val().length
-          y.val(_.random(0, l-1), @getRandomText(), 'immutable')
-          null
-        types : [types.Array]
-      , f : (y)=> # Delete Object Property
-          list = for name, o of y.val()
-            name
-          if list.length > 0
-            key = list[_random(0,list.length-1)]
-            y.delete(key)
-        types: [types.Object]
-      , f : (y)=> # SET Object Property
-          y.val(@getRandomKey(), @getRandomObject())
-        types: [types.Object]
-      ,
-        f : (y)=> # SET PROPERTY TEXT
-          y.val(@getRandomKey(), @getRandomText(), 'mutable')
-        types: [types.Object]
-    ]
-
-describe "JsonFramework", ->
-  beforeEach (done)->
-    @timeout 50000
-    @yTest = new JsonTest()
-    @users = @yTest.users
-
-    @test_user = @yTest.makeNewUser "test_user"
-    done()
-
-  it "can handle many engines, many operations, concurrently (random)", ->
-    console.log "" # TODO
-    @yTest.run()
-
-  it "has a working test suite", ->
-    @yTest.compareAll()
-
-  it "handles double-late-join", ->
-    test = new JsonTest("double")
-    test.run()
-    @yTest.run()
-    u1 = test.users[0]
-    u2 = @yTest.users[1]
-    ops1 = u1.HB._encode()
-    ops2 = u2.HB._encode()
-    u1.HB.renewStateVector u2.HB.getOperationCounter()
-    u2.HB.renewStateVector u1.HB.getOperationCounter()
-    u1.engine.applyOps ops2
-    u2.engine.applyOps ops1
-    expect(test.getContent(0)).to.deep.equal(@yTest.getContent(1))
-
-  it "can handle creaton of complex json (1)", ->
-    @yTest.users[0].val('a', 'q', "mutable")
-    @yTest.users[1].val('a', 't', "mutable")
-    @yTest.compareAll()
-    q = @yTest.users[2].val('a')
-    q.insert(0,'A')
-    @yTest.compareAll()
-    expect(@yTest.getSomeUser().val("a").val()).to.equal("At")
-
-  it "can handle creaton of complex json (2)", ->
-    @yTest.getSomeUser().val('x', {'a':'b'})
-    @yTest.getSomeUser().val('a', {'a':{q:"dtrndtrtdrntdrnrtdnrtdnrtdnrtdnrdnrdt"}}, "mutable")
-    @yTest.getSomeUser().val('b', {'a':{}})
-    @yTest.getSomeUser().val('c', {'a':'c'})
-    @yTest.getSomeUser().val('c', {'a':'b'})
-    @yTest.compareAll()
-    q = @yTest.getSomeUser().val("a").val("a").val("q")
-    q.insert(0,'A')
-    @yTest.compareAll()
-    expect(@yTest.getSomeUser().val("a").val("a").val("q").val()).to.equal("Adtrndtrtdrntdrnrtdnrtdnrtdnrtdnrdnrdt")
-
-  it "can handle creaton of complex json (3)", ->
-    @yTest.users[0].val('l', [1,2,3], "mutable")
-    @yTest.users[1].val('l', [4,5,6], "mutable")
-    @yTest.compareAll()
-    @yTest.users[2].val('l').insert(0,'A')
-    w = @yTest.users[1].val('l').insert(0,'B', "mutable").val(0)
-    w.insert 1, "C"
-    expect(w.val()).to.equal("BC")
-    @yTest.compareAll()
-
-  it "handles immutables and primitive data types", ->
-    @yTest.getSomeUser().val('string', "text", "immutable")
-    @yTest.getSomeUser().val('number', 4, "immutable")
-    @yTest.getSomeUser().val('object', {q:"rr"}, "immutable")
-    @yTest.getSomeUser().val('null', null)
-    @yTest.compareAll()
-    expect(@yTest.getSomeUser().val('string')).to.equal "text"
-    expect(@yTest.getSomeUser().val('number')).to.equal 4
-    expect(@yTest.getSomeUser().val('object').val('q')).to.equal "rr"
-    expect(@yTest.getSomeUser().val('null') is null).to.be.ok
-
-  it "handles immutables and primitive data types (2)", ->
-    @yTest.users[0].val('string', "text", "immutable")
-    @yTest.users[1].val('number', 4, "immutable")
-    @yTest.users[2].val('object', {q:"rr"}, "immutable")
-    @yTest.users[0].val('null', null)
-    @yTest.compareAll()
-    expect(@yTest.getSomeUser().val('string')).to.equal "text"
-    expect(@yTest.getSomeUser().val('number')).to.equal 4
-    expect(@yTest.getSomeUser().val('object').val('q')).to.equal "rr"
-    expect(@yTest.getSomeUser().val('null') is null).to.be.ok
-
-  it "Observers work on JSON Types (add type observers, local and foreign)", ->
-    u = @yTest.users[0]
-    @yTest.flushAll()
-    last_task = null
-    observer1 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("add")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('0')
-      expect(change.name).to.equal("newStuff")
-      last_task = "observer1"
-    u.observe observer1
-    u.val("newStuff","someStuff","mutable")
-    expect(last_task).to.equal("observer1")
-    u.unobserve observer1
-
-    observer2 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("add")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('1')
-      expect(change.name).to.equal("moreStuff")
-      last_task = "observer2"
-    u.observe observer2
-    v = @yTest.users[1]
-    v.val("moreStuff","someMoreStuff")
-    @yTest.flushAll()
-    expect(last_task).to.equal("observer2")
-    u.unobserve observer2
-
-  it "Observers work on JSON Types (update type observers, local and foreign)", ->
-    u = @yTest.users[0].val("newStuff","oldStuff","mutable").val("moreStuff","moreOldStuff","mutable")
-    @yTest.flushAll()
-    last_task = null
-    observer1 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("update")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('0')
-      expect(change.name).to.equal("newStuff")
-      expect(change.oldValue.val()).to.equal("oldStuff")
-      last_task = "observer1"
-    u.observe observer1
-    u.val("newStuff","someStuff")
-    expect(last_task).to.equal("observer1")
-    u.unobserve observer1
-
-    observer2 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("update")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('1')
-      expect(change.name).to.equal("moreStuff")
-      expect(change.oldValue.val()).to.equal("moreOldStuff")
-      last_task = "observer2"
-    u.observe observer2
-    v = @yTest.users[1]
-    v.val("moreStuff","someMoreStuff")
-    @yTest.flushAll()
-    expect(last_task).to.equal("observer2")
-    u.unobserve observer2
-
-
-  it "Observers work on JSON Types (delete type observers, local and foreign)", ->
-    u = @yTest.users[0].val("newStuff","oldStuff","mutable").val("moreStuff","moreOldStuff","mutable")
-    @yTest.flushAll()
-    last_task = null
-    observer1 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("delete")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('0')
-      expect(change.name).to.equal("newStuff")
-      expect(change.oldValue.val()).to.equal("oldStuff")
-      last_task = "observer1"
-    u.observe observer1
-    u.delete("newStuff")
-    expect(last_task).to.equal("observer1")
-    u.unobserve observer1
-
-    observer2 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("delete")
-      expect(change.object).to.equal(u)
-      expect(change.changedBy).to.equal('1')
-      expect(change.name).to.equal("moreStuff")
-      expect(change.oldValue.val()).to.equal("moreOldStuff")
-      last_task = "observer2"
-    u.observe observer2
-    v = @yTest.users[1]
-    v.delete("moreStuff")
-    @yTest.flushAll()
-    expect(last_task).to.equal("observer2")
-    u.unobserve observer2
-
-
-

test/TestSuite.coffee

@@ -1,208 +0,0 @@
-chai      = require('chai')
-expect    = chai.expect
-should    = chai.should()
-sinon     = require('sinon')
-sinonChai = require('sinon-chai')
-_         = require("underscore")
-
-chai.use(sinonChai)
-
-Connector = require "../../y-test/lib/y-test.coffee"
-
-module.exports = class Test
-  constructor: (@name_suffix = "")->
-    @number_of_test_cases_multiplier = 1
-    @repeat_this = 3 * @number_of_test_cases_multiplier
-    @doSomething_amount = 123 * @number_of_test_cases_multiplier
-    @number_of_engines = 5 + @number_of_test_cases_multiplier - 1
-
-    @time = 0 # denotes to the time when run was started
-    @ops = 0 # number of operations (used with @time)
-    @time_now = 0 # current time
-
-    @debug = false
-
-    @reinitialize()
-
-  reinitialize: ()->
-    @users = []
-    for i in [0...@number_of_engines]
-      u = @makeNewUser (i+@name_suffix)
-      for user in @users
-        u.getConnector().join(user.getConnector()) # TODO: change the test-connector to make this more convenient
-      @users.push u
-    @initUsers?(@users[0])
-    @flushAll()
-
-  # is called by implementing class
-  makeNewUser: (user)->
-    user.HB.setManualGarbageCollect()
-    user
-
-  getSomeUser: ()->
-    i = _.random 0, (@users.length-1)
-    @users[i]
-
-  getRandomText: (chars, min_length = 0)->
-    chars ?= "abcdefghijklmnopqrstuvwxyz"
-    length = _.random min_length, 10
-    #length = 1
-    nextchar = chars[(_.random 0, (chars.length-1))]
-    text = ""
-    _(length).times ()-> text += nextchar
-    text
-
-  getRandomObject: ()->
-    result = {}
-    key1 = @getRandomKey()
-    key2 = @getRandomKey()
-    val1 = @getRandomText()
-    val2 = null
-    if _.random(0,1) is 1
-      val2 = @getRandomObject()
-    else
-      val2 = @getRandomText()
-    result[key1] = val1
-    result[key2] = val2
-    result
-
-  getRandomKey: ()->
-    @getRandomText [1,2,'x','y'], 1 # only 4 keys
-
-  getGeneratingFunctions: (user_num)=>
-    types = @users[user_num].types
-    [
-        f : (y)=> # INSERT TEXT
-          y
-          pos = _.random 0, (y.val().length-1)
-          y.insert pos, @getRandomText()
-          null
-        types: [types.String]
-      ,
-        f : (y)-> # DELETE TEXT
-          if y.val().length > 0
-            pos = _.random 0, (y.val().length-1) # TODO: put here also arbitrary number (test behaviour in error cases)
-            length = _.random 0, (y.val().length - pos)
-            ops1 = y.delete pos, length
-          undefined
-        types : [types.String]
-    ]
-  getRandomRoot: (user_num)->
-    throw new Error "overwrite me!"
-
-  getContent: (user_num)->
-    throw new Error "overwrite me!"
-
-  generateRandomOp: (user_num)=>
-    y = @getRandomRoot(user_num)
-    choices = @getGeneratingFunctions(user_num).filter (gf)->
-      _.some gf.types, (type)->
-        y instanceof type
-
-    if choices.length is 0
-      console.dir(y)
-      throw new Error "You forgot to specify a test generation methot for this Operation! (#{y.type})"
-    i = _.random 0, (choices.length-1)
-    choices[i].f y
-
-  applyRandomOp: (user_num)=>
-    user = @users[user_num]
-    user.getConnector().flushOneRandom()
-
-  doSomething: ()->
-    user_num = _.random (@number_of_engines-1)
-    choices = [@applyRandomOp, @generateRandomOp]
-    choice = _.random (choices.length-1)
-    choices[choice](user_num)
-
-  flushAll: (final)->
-    # TODO:!!
-    final = false
-    if @users.length <= 1 or not final
-      for user,user_number in @users
-        user.getConnector().flushAll()
-    else
-      for user,user_number in @users[1..]
-        user.getConnector().flushAll()
-      ops = @users[1].getHistoryBuffer()._encode @users[0].HB.getOperationCounter()
-      @users[0].engine.applyOpsCheckDouble ops
-
-
-
-  compareAll: (test_number)->
-    @flushAll(true)
-
-    @time += (new Date()).getTime() - @time_now
-
-    number_of_created_operations = 0
-    for i in [0...(@users.length)]
-      number_of_created_operations += @users[i].getConnector().getOpsInExecutionOrder().length
-    @ops += number_of_created_operations*@users.length
-
-    ops_per_msek = Math.floor(@ops/@time)
-    if test_number? # and @debug
-      console.log "#{test_number}/#{@repeat_this}: #{number_of_created_operations} were created and applied on (#{@users.length}) users ops in a different order." + " Over all we consumed #{@ops} operations in #{@time/1000} seconds (#{ops_per_msek} ops/msek)."
-
-    for i in [0...(@users.length-1)]
-      if @debug
-        if not _.isEqual @getContent(i), @getContent(i+1)
-          printOpsInExecutionOrder = (otnumber, otherotnumber)=>
-            ops = _.filter @users[otnumber].getConnector().getOpsInExecutionOrder(), (o)->
-              typeof o.uid.op_name isnt 'string' and o.uid.creator isnt '_'
-            for s,j in ops
-              console.log "op#{j} = " + (JSON.stringify s)
-            console.log ""
-            s = "ops = ["
-            for o,j in ops
-              if j isnt 0
-                s += ", "
-              s += "op#{j}"
-            s += "]"
-            console.log s
-            console.log "@test_user.engine.applyOps ops"
-            console.log "expect(@test_user.val('name').val()).to.equal(\"#{@users[otherotnumber].val('name').val()}\")"
-            ops
-          console.log ""
-          console.log "Found an OT Puzzle!"
-          console.log "OT states:"
-          for u,j in @users
-            console.log "OT#{j}: "+u.val('name').val()
-          console.log "\nOT execution order (#{i},#{i+1}):"
-          printOpsInExecutionOrder i, i+1
-          console.log ""
-          ops = printOpsInExecutionOrder i+1, i
-
-          console.log ""
-      expect(@getContent(i)).to.deep.equal(@getContent(i+1))
-
-  run: ()->
-    if @debug
-      console.log ''
-    for times in [1..@repeat_this]
-      @time_now = (new Date).getTime()
-      for i in [1..Math.floor(@doSomething_amount/2)]
-        @doSomething()
-      @flushAll(false)
-      for u in @users
-        u.HB.emptyGarbage()
-      for i in [1..Math.floor(@doSomething_amount/2)]
-        @doSomething()
-
-      @compareAll(times)
-      @testHBencoding()
-      if times isnt @repeat_this
-        @reinitialize()
-
-  testHBencoding: ()->
-    # in case of JsonFramework, every user will create its JSON first! therefore, the testusers id must be small than all the others (see InsertType)
-    @users[@users.length] = @makeNewUser (-1) # this does not want to join with anymody
-
-    @users[@users.length-1].HB.renewStateVector @users[0].HB.getOperationCounter()
-    @users[@users.length-1].engine.applyOps @users[0].HB._encode()
-
-    #if @getContent(@users.length-1) isnt @getContent(0)
-    #  console.log "testHBencoding:"
-    #  console.log "Unprocessed ops first: #{@users[0].engine.unprocessed_ops.length}"
-    #  console.log "Unprocessed ops last: #{@users[@users.length-1].engine.unprocessed_ops.length}"
-    expect(@getContent(@users.length-1)).to.deep.equal(@getContent(0))
-

test/Text_test.coffee

@@ -1,119 +0,0 @@
-chai      = require('chai')
-expect    = chai.expect
-should    = chai.should()
-sinon     = require('sinon')
-sinonChai = require('sinon-chai')
-_         = require("underscore")
-
-chai.use(sinonChai)
-
-Y = require "../lib/y"
-Connector = require "../../y-test/lib/y-test.coffee"
-
-Test = require "./TestSuite"
-class TextTest extends Test
-
-  type: "TextTest"
-
-  makeNewUser: (userId)->
-    conn = new Connector userId
-    new Y conn
-
-  initUsers: (u)->
-    u.val("TextTest","","mutable")
-
-  getRandomRoot: (user_num)->
-    @users[user_num].val("TextTest")
-
-  getContent: (user_num)->
-    @users[user_num].val("TextTest").val()
-
-describe "TextFramework", ->
-  beforeEach (done)->
-    @timeout 50000
-    @yTest = new TextTest()
-    done()
-
-  it "simple multi-char insert", ->
-    u = @yTest.users[0].val("TextTest")
-    u.insert 0, "abc"
-    u = @yTest.users[1].val("TextTest")
-    u.insert 0, "xyz"
-    @yTest.compareAll()
-    u.delete 0, 1
-    @yTest.compareAll()
-    expect(u.val()).to.equal("bcxyz")
-
-  it "Observers work on shared Text (insert type observers, local and foreign)", ->
-    u = @yTest.users[0].val("TextTest","my awesome Text","mutable").val("TextTest")
-    @yTest.flushAll()
-    last_task = null
-    observer1 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("insert")
-      expect(change.object).to.equal(u)
-      expect(change.value).to.equal("a")
-      expect(change.position).to.equal(1)
-      expect(change.changedBy).to.equal('0')
-      last_task = "observer1"
-    u.observe observer1
-    u.insert 1, "a"
-    expect(last_task).to.equal("observer1")
-    u.unobserve observer1
-
-    observer2 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("insert")
-      expect(change.object).to.equal(u)
-      expect(change.value).to.equal("x")
-      expect(change.position).to.equal(0)
-      expect(change.changedBy).to.equal('1')
-      last_task = "observer2"
-    u.observe observer2
-    v = @yTest.users[1].val("TextTest")
-    v.insert 0, "x"
-    @yTest.flushAll()
-    expect(last_task).to.equal("observer2")
-    u.unobserve observer2
-
-  it "Observers work on shared Text (delete type observers, local and foreign)", ->
-    u = @yTest.users[0].val("TextTest","my awesome Text","mutable").val("TextTest")
-    @yTest.flushAll()
-    last_task = null
-    observer1 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("delete")
-      expect(change.object).to.equal(u)
-      expect(change.position).to.equal(1)
-      expect(change.length).to.equal(1)
-      expect(change.changedBy).to.equal('0')
-      last_task = "observer1"
-    u.observe observer1
-    u.delete 1, 1
-    expect(last_task).to.equal("observer1")
-    u.unobserve observer1
-
-    observer2 = (changes)->
-      expect(changes.length).to.equal(1)
-      change = changes[0]
-      expect(change.type).to.equal("delete")
-      expect(change.object).to.equal(u)
-      expect(change.position).to.equal(0)
-      expect(change.length).to.equal(1)
-      expect(change.changedBy).to.equal('1')
-      last_task = "observer2"
-    u.observe observer2
-    v = @yTest.users[1].val("TextTest")
-    v.delete 0, 1
-    @yTest.flushAll()
-    expect(last_task).to.equal("observer2")
-    u.unobserve observer2
-
-  it "can handle many engines, many operations, concurrently (random)", ->
-    console.log("testiy deleted this TODO:dtrn")
-    @yTest.run()
-
-

test/Xml_test_browser.coffee

@@ -1,196 +0,0 @@
-chai      = require('chai')
-expect    = chai.expect
-should    = chai.should()
-sinon     = require('sinon')
-sinonChai = require('sinon-chai')
-_         = require("underscore")
-$         = require("jquery")
-document?.$ = $ # for browser
-require 'coffee-errors'
-
-chai.use(sinonChai)
-
-Y = require "../lib/index"
-Connector = require "../../y-test/lib/y-test.coffee"
-
-Test = require "./TestSuite"
-class XmlTest extends Test
-
-  type: "XmlTest"
-
-  makeNewUser: (user, conn)->
-    super new Y.XmlFramework user, conn
-
-  getRandomRoot: (user_num)->
-    @users[user_num].getSharedObject()
-
-  getContent: (user_num)->
-    @users[user_num].val()
-
-
-describe "XmlFramework", ->
-  beforeEach (done)->
-    @timeout 50000
-    @yTest = new XmlTest()
-    ###
-
-    @users = @yTest.users
-    ###
-    test_users = []
-    connector = (new Connector 0, test_users)
-    @test_user = @yTest.makeNewUser 0, connector
-    test_users.push @test_user
-    # test_user_listen listens to the actions of test_user. He will update his dom when he receives from test_user.
-    @test_user_listen = @yTest.makeNewUser 2, connector
-    test_users.push @test_user_listen
-    @test_user2 = @yTest.makeNewUser 1, (Connector_uninitialized [])
-
-    $("#test_dom").replaceWith('<div id="test_dom" test_attribute="the test" class="stuffy" style="color: blue"><p id="replaceme">replace me</p><p id="removeme">remove me</p><p>This is a test object for <b>XmlFramework</b></p><span class="span_element"><p>span</p></span></div>')
-    @$dom = $("#test_dom")
-    @dom = @$dom[0]
-    @test_user.val(@dom)
-    @test_user_listen.getConnector().flushAll()
-    @test_user_listen_dom = @test_user_listen.val()
-
-    @check = ()=>
-      dom_ = @dom.outerHTML
-      # now test if other collaborators can parse the HB and result in the same content
-      hb = @test_user.HB._encode()
-      @test_user2.engine.applyOps(hb)
-      dom2 = @test_user2.val()
-      expect(dom_).to.equal(dom2.outerHTML)
-      @test_user_listen.getConnector().flushAll()
-      expect(dom_).to.equal(@test_user_listen_dom.outerHTML)
-    done()
-
-  it "can transform to a new real Dom element", ->
-    dom_ = @test_user.val(true)
-    expect(dom_ isnt @dom).to.be.true
-
-  it "supports dom.insertBefore", ->
-    newdom = $("<p>dtrn</p>")[0]
-    newdom2 = $("<p>dtrn2</p>")[0]
-    n = $("#removeme")[0]
-    @dom.insertBefore(newdom, null)
-    @dom.insertBefore(newdom2, n)
-    @check()
-
-  it "supports dom.appendChild", ->
-    newdom = $("<p>dtrn</p>")[0]
-    @dom.appendChild(newdom)
-    @check()
-
-  it "supports dom.setAttribute", ->
-    @dom.setAttribute("test_attribute", "newVal")
-    @check()
-
-  it "supports dom.removeAttribute", ->
-    @dom.removeAttribute("test_attribute")
-    @check()
-
-  it "supports dom.removeChild", ->
-    @dom.removeChild($("#removeme")[0])
-    expect($("#removeme").length).to.equal(0)
-    @check()
-
-  it "supports dom.replaceChild", ->
-    newdom = $("<p>replaced</p>")[0]
-    replace = $("#replaceme")[0]
-    @dom.replaceChild(newdom,replace)
-    expect($("#replaceme").length).to.equal(0)
-    @check()
-
-  it "supports dom.classList.add", ->
-    @dom.classList.add "classy"
-    @check()
-
-
-  it "supports dom.textcontent", -> #TODO!!!!
-    @dom.classList.add "classy"
-    @check()
-
-  it "supports jquery.addClass", ->
-    @$dom.addClass("testy")
-    @check()
-
-  it "supports jquery.after", ->
-    d = $("#test_dom p")
-    d.after("<div class=\"inserted_after\">after</div>")
-    @check()
-
-  it "supports jquery.append", ->
-    d = $("#test_dom p")
-    d.after("<b>appended</b>")
-    @check()
-
-  it "supports jquery.appendTo", ->
-    $("<b>appendedTo</b>").appendTo("#test_dom p")
-    $("p").appendTo("#test_dom")
-    @check()
-
-  it "supports jquery.before", ->
-    d = $("#test_dom p")
-    d.before("<div>before</div>")
-    @check()
-
-  it "supports jquery.detach", ->
-    d = $(".inserted_after")
-    d.detach()
-    @check()
-
-  it "supports jquery.empty", ->
-    d = $("#test_dom p")
-    d.empty()
-    @check()
-
-  it "supports jquery.insertAfter", ->
-    $("<p>after span</p>").insertAfter(".span_element")
-    @check()
-
-  it "supports jquery.insertBefore", ->
-    $("<p>before span</p>").insertBefore(".span_element")
-    @check()
-
-  it "supports jquery.prepend", ->
-    d = $("#test_dom div")
-    d.prepend("<p>prepended</p>")
-    @check()
-
-  it "supports jquery.prependTo", ->
-    $("<p atone=false attwo=\"dtrn\" class=\"attr_node sudo su\">prepended to</p>").prependTo("#test_dom div")
-    @check()
-
-  it "supports jquery.remove", ->
-    d = $("#test_dom b")
-    d.remove()
-    @check()
-
-  it "supports jquery.removeAttr", ->
-    d = $(".attr_node")
-    d.removeAttr("attwo")
-    @check()
-
-  it "supports jquery.removeClass", ->
-    d = $(".attr_node")
-    d.removeClass("sudo")
-    @check()
-
-  it "supports jquery.attr", ->
-    d = $(".attr_node")
-    d.attr("atone", true)
-    @check()
-
-  it "supports jquery.replaceAll", ->
-    $("<span>New span content </span>").replaceAll("#test_dom div")
-    @check()
-
-  it "supports jquery.replaceWith", ->
-    d = $("#test_dom span")
-    d.replaceWith("<div>me is div again </div>")
-    @check()
-
-
-
-
-
-

tests/encoding.tests.js

@@ -0,0 +1,28 @@
+import * as t from 'lib0/testing.js'
+
+import {
+  contentRefs,
+  readContentBinary,
+  readContentDeleted,
+  readContentString,
+  readContentJSON,
+  readContentEmbed,
+  readContentType,
+  readContentFormat,
+  readContentAny
+} from '../src/internals.js'
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testStructReferences = tc => {
+  t.assert(contentRefs.length === 9)
+  t.assert(contentRefs[1] === readContentDeleted)
+  t.assert(contentRefs[2] === readContentJSON) // TODO: deprecate content json?
+  t.assert(contentRefs[3] === readContentBinary)
+  t.assert(contentRefs[4] === readContentString)
+  t.assert(contentRefs[5] === readContentEmbed)
+  t.assert(contentRefs[6] === readContentFormat)
+  t.assert(contentRefs[7] === readContentType)
+  t.assert(contentRefs[8] === readContentAny)
+}

tests/index.js

@@ -0,0 +1,23 @@
+
+import * as array from './y-array.tests.js'
+import * as map from './y-map.tests.js'
+import * as text from './y-text.tests.js'
+import * as xml from './y-xml.tests.js'
+import * as encoding from './encoding.tests.js'
+import * as undoredo from './undo-redo.tests.js'
+
+import { runTests } from 'lib0/testing.js'
+import { isBrowser, isNode } from 'lib0/environment.js'
+import * as log from 'lib0/logging.js'
+
+if (isBrowser) {
+  log.createVConsole(document.body)
+}
+runTests({
+  map, array, text, xml, encoding, undoredo
+}).then(success => {
+  /* istanbul ignore next */
+  if (isNode) {
+    process.exit(success ? 0 : 1)
+  }
+})

tests/testHelper.js

@@ -0,0 +1,416 @@
+import * as Y from '../src/index.js'
+
+import {
+  createDeleteSetFromStructStore,
+  getStateVector,
+  Item,
+  DeleteItem, DeleteSet, StructStore, Doc // eslint-disable-line
+} from '../src/internals.js'
+
+import * as t from 'lib0/testing.js'
+import * as prng from 'lib0/prng.js'
+import * as encoding from 'lib0/encoding.js'
+import * as decoding from 'lib0/decoding.js'
+import * as syncProtocol from 'y-protocols/sync.js'
+import * as object from 'lib0/object.js'
+export * from '../src/internals.js'
+
+/**
+ * @param {TestYInstance} y // publish message created by `y` to all other online clients
+ * @param {Uint8Array} m
+ */
+const broadcastMessage = (y, m) => {
+  if (y.tc.onlineConns.has(y)) {
+    y.tc.onlineConns.forEach(remoteYInstance => {
+      if (remoteYInstance !== y) {
+        remoteYInstance._receive(m, y)
+      }
+    })
+  }
+}
+
+export class TestYInstance extends Doc {
+  /**
+   * @param {TestConnector} testConnector
+   * @param {number} clientID
+   */
+  constructor (testConnector, clientID) {
+    super()
+    this.userID = clientID // overwriting clientID
+    /**
+     * @type {TestConnector}
+     */
+    this.tc = testConnector
+    /**
+     * @type {Map<TestYInstance, Array<Uint8Array>>}
+     */
+    this.receiving = new Map()
+    testConnector.allConns.add(this)
+    // set up observe on local model
+    this.on('update', /** @param {Uint8Array} update @param {any} origin */ (update, origin) => {
+      if (origin !== testConnector) {
+        const encoder = encoding.createEncoder()
+        syncProtocol.writeUpdate(encoder, update)
+        broadcastMessage(this, encoding.toUint8Array(encoder))
+      }
+    })
+    this.connect()
+  }
+
+  /**
+   * Disconnect from TestConnector.
+   */
+  disconnect () {
+    this.receiving = new Map()
+    this.tc.onlineConns.delete(this)
+  }
+
+  /**
+   * Append yourself to the list of known Y instances in testconnector.
+   * Also initiate sync with all clients.
+   */
+  connect () {
+    if (!this.tc.onlineConns.has(this)) {
+      this.tc.onlineConns.add(this)
+      const encoder = encoding.createEncoder()
+      syncProtocol.writeSyncStep1(encoder, this)
+      // publish SyncStep1
+      broadcastMessage(this, encoding.toUint8Array(encoder))
+      this.tc.onlineConns.forEach(remoteYInstance => {
+        if (remoteYInstance !== this) {
+          // remote instance sends instance to this instance
+          const encoder = encoding.createEncoder()
+          syncProtocol.writeSyncStep1(encoder, remoteYInstance)
+          this._receive(encoding.toUint8Array(encoder), remoteYInstance)
+        }
+      })
+    }
+  }
+
+  /**
+   * Receive a message from another client. This message is only appended to the list of receiving messages.
+   * TestConnector decides when this client actually reads this message.
+   *
+   * @param {Uint8Array} message
+   * @param {TestYInstance} remoteClient
+   */
+  _receive (message, remoteClient) {
+    let messages = this.receiving.get(remoteClient)
+    if (messages === undefined) {
+      messages = []
+      this.receiving.set(remoteClient, messages)
+    }
+    messages.push(message)
+  }
+}
+
+/**
+ * Keeps track of TestYInstances.
+ *
+ * The TestYInstances add/remove themselves from the list of connections maiained in this object.
+ * I think it makes sense. Deal with it.
+ */
+export class TestConnector {
+  /**
+   * @param {prng.PRNG} gen
+   */
+  constructor (gen) {
+    /**
+     * @type {Set<TestYInstance>}
+     */
+    this.allConns = new Set()
+    /**
+     * @type {Set<TestYInstance>}
+     */
+    this.onlineConns = new Set()
+    /**
+     * @type {prng.PRNG}
+     */
+    this.prng = gen
+  }
+
+  /**
+   * Create a new Y instance and add it to the list of connections
+   * @param {number} clientID
+   */
+  createY (clientID) {
+    return new TestYInstance(this, clientID)
+  }
+
+  /**
+   * Choose random connection and flush a random message from a random sender.
+   *
+   * If this function was unable to flush a message, because there are no more messages to flush, it returns false. true otherwise.
+   * @return {boolean}
+   */
+  flushRandomMessage () {
+    const gen = this.prng
+    const conns = Array.from(this.onlineConns).filter(conn => conn.receiving.size > 0)
+    if (conns.length > 0) {
+      const receiver = prng.oneOf(gen, conns)
+      const [sender, messages] = prng.oneOf(gen, Array.from(receiver.receiving))
+      const m = messages.shift()
+      if (messages.length === 0) {
+        receiver.receiving.delete(sender)
+      }
+      if (m === undefined) {
+        return this.flushRandomMessage()
+      }
+      const encoder = encoding.createEncoder()
+      // console.log('receive (' + sender.userID + '->' + receiver.userID + '):\n', syncProtocol.stringifySyncMessage(decoding.createDecoder(m), receiver))
+      // do not publish data created when this function is executed (could be ss2 or update message)
+      syncProtocol.readSyncMessage(decoding.createDecoder(m), encoder, receiver, receiver.tc)
+      if (encoding.length(encoder) > 0) {
+        // send reply message
+        sender._receive(encoding.toUint8Array(encoder), receiver)
+      }
+      return true
+    }
+    return false
+  }
+
+  /**
+   * @return {boolean} True iff this function actually flushed something
+   */
+  flushAllMessages () {
+    let didSomething = false
+    while (this.flushRandomMessage()) {
+      didSomething = true
+    }
+    return didSomething
+  }
+
+  reconnectAll () {
+    this.allConns.forEach(conn => conn.connect())
+  }
+
+  disconnectAll () {
+    this.allConns.forEach(conn => conn.disconnect())
+  }
+
+  syncAll () {
+    this.reconnectAll()
+    this.flushAllMessages()
+  }
+
+  /**
+   * @return {boolean} Whether it was possible to disconnect a randon connection.
+   */
+  disconnectRandom () {
+    if (this.onlineConns.size === 0) {
+      return false
+    }
+    prng.oneOf(this.prng, Array.from(this.onlineConns)).disconnect()
+    return true
+  }
+
+  /**
+   * @return {boolean} Whether it was possible to reconnect a random connection.
+   */
+  reconnectRandom () {
+    /**
+     * @type {Array<TestYInstance>}
+     */
+    const reconnectable = []
+    this.allConns.forEach(conn => {
+      if (!this.onlineConns.has(conn)) {
+        reconnectable.push(conn)
+      }
+    })
+    if (reconnectable.length === 0) {
+      return false
+    }
+    prng.oneOf(this.prng, reconnectable).connect()
+    return true
+  }
+}
+
+/**
+ * @template T
+ * @param {t.TestCase} tc
+ * @param {{users?:number}} conf
+ * @param {InitTestObjectCallback<T>} [initTestObject]
+ * @return {{testObjects:Array<any>,testConnector:TestConnector,users:Array<TestYInstance>,array0:Y.Array<any>,array1:Y.Array<any>,array2:Y.Array<any>,map0:Y.Map<any>,map1:Y.Map<any>,map2:Y.Map<any>,map3:Y.Map<any>,text0:Y.Text,text1:Y.Text,text2:Y.Text,xml0:Y.XmlElement,xml1:Y.XmlElement,xml2:Y.XmlElement}}
+ */
+export const init = (tc, { users = 5 } = {}, initTestObject) => {
+  /**
+   * @type {Object<string,any>}
+   */
+  const result = {
+    users: []
+  }
+  const gen = tc.prng
+  const testConnector = new TestConnector(gen)
+  result.testConnector = testConnector
+  for (let i = 0; i < users; i++) {
+    const y = testConnector.createY(i)
+    y.clientID = i
+    result.users.push(y)
+    result['array' + i] = y.get('array', Y.Array)
+    result['map' + i] = y.get('map', Y.Map)
+    result['xml' + i] = y.get('xml', Y.XmlElement)
+    result['text' + i] = y.get('text', Y.Text)
+  }
+  testConnector.syncAll()
+  result.testObjects = result.users.map(initTestObject || (() => null))
+  return /** @type {any} */ (result)
+}
+
+/**
+ * 1. reconnect and flush all
+ * 2. user 0 gc
+ * 3. get type content
+ * 4. disconnect & reconnect all (so gc is propagated)
+ * 5. compare os, ds, ss
+ *
+ * @param {Array<TestYInstance>} users
+ */
+export const compare = users => {
+  users.forEach(u => u.connect())
+  while (users[0].tc.flushAllMessages()) {}
+  const userArrayValues = users.map(u => u.getArray('array').toJSON())
+  const userMapValues = users.map(u => u.getMap('map').toJSON())
+  const userXmlValues = users.map(u => u.get('xml', Y.XmlElement).toString())
+  const userTextValues = users.map(u => u.getText('text').toDelta())
+  for (const u of users) {
+    t.assert(u.store.pendingDeleteReaders.length === 0)
+    t.assert(u.store.pendingStack.length === 0)
+    t.assert(u.store.pendingClientsStructRefs.size === 0)
+  }
+  // Test Array iterator
+  t.compare(users[0].getArray('array').toArray(), Array.from(users[0].getArray('array')))
+  // Test Map iterator
+  const ymapkeys = Array.from(users[0].getMap('map').keys())
+  t.assert(ymapkeys.length === Object.keys(userMapValues[0]).length)
+  ymapkeys.forEach(key => t.assert(object.hasProperty(userMapValues[0], key)))
+  /**
+   * @type {Object<string,any>}
+   */
+  const mapRes = {}
+  for (const [k, v] of users[0].getMap('map')) {
+    mapRes[k] = v instanceof Y.AbstractType ? v.toJSON() : v
+  }
+  t.compare(userMapValues[0], mapRes)
+  // Compare all users
+  for (let i = 0; i < users.length - 1; i++) {
+    t.compare(userArrayValues[i].length, users[i].getArray('array').length)
+    t.compare(userArrayValues[i], userArrayValues[i + 1])
+    t.compare(userMapValues[i], userMapValues[i + 1])
+    t.compare(userXmlValues[i], userXmlValues[i + 1])
+    t.compare(userTextValues[i].map(/** @param {any} a */ a => typeof a.insert === 'string' ? a.insert : ' ').join('').length, users[i].getText('text').length)
+    t.compare(userTextValues[i], userTextValues[i + 1])
+    t.compare(getStateVector(users[i].store), getStateVector(users[i + 1].store))
+    compareDS(createDeleteSetFromStructStore(users[i].store), createDeleteSetFromStructStore(users[i + 1].store))
+    compareStructStores(users[i].store, users[i + 1].store)
+  }
+  users.map(u => u.destroy())
+}
+
+/**
+ * @param {Item?} a
+ * @param {Item?} b
+ * @return {boolean}
+ */
+export const compareItemIDs = (a, b) => a === b || (a !== null && b != null && Y.compareIDs(a.id, b.id))
+
+/**
+ * @param {StructStore} ss1
+ * @param {StructStore} ss2
+ */
+export const compareStructStores = (ss1, ss2) => {
+  t.assert(ss1.clients.size === ss2.clients.size)
+  for (const [client, structs1] of ss1.clients) {
+    const structs2 = /** @type {Array<Y.AbstractStruct>} */ (ss2.clients.get(client))
+    t.assert(structs2 !== undefined && structs1.length === structs2.length)
+    for (let i = 0; i < structs1.length; i++) {
+      const s1 = structs1[i]
+      const s2 = structs2[i]
+      // checks for abstract struct
+      if (
+        s1.constructor !== s2.constructor ||
+        !Y.compareIDs(s1.id, s2.id) ||
+        s1.deleted !== s2.deleted ||
+        s1.length !== s2.length
+      ) {
+        t.fail('Structs dont match')
+      }
+      if (s1 instanceof Item) {
+        if (
+          !(s2 instanceof Item) ||
+          !((s1.left === null && s2.left === null) || (s1.left !== null && s2.left !== null && Y.compareIDs(s1.left.lastId, s2.left.lastId))) ||
+          !compareItemIDs(s1.right, s2.right) ||
+          !Y.compareIDs(s1.origin, s2.origin) ||
+          !Y.compareIDs(s1.rightOrigin, s2.rightOrigin) ||
+          s1.parentSub !== s2.parentSub
+        ) {
+          return t.fail('Items dont match')
+        }
+        // make sure that items are connected correctly
+        t.assert(s1.left === null || s1.left.right === s1)
+        t.assert(s1.right === null || s1.right.left === s1)
+        t.assert(s2.left === null || s2.left.right === s2)
+        t.assert(s2.right === null || s2.right.left === s2)
+      }
+    }
+  }
+}
+
+/**
+ * @param {DeleteSet} ds1
+ * @param {DeleteSet} ds2
+ */
+export const compareDS = (ds1, ds2) => {
+  t.assert(ds1.clients.size === ds2.clients.size)
+  for (const [client, deleteItems1] of ds1.clients) {
+    const deleteItems2 = /** @type {Array<DeleteItem>} */ (ds2.clients.get(client))
+    t.assert(deleteItems2 !== undefined && deleteItems1.length === deleteItems2.length)
+    for (let i = 0; i < deleteItems1.length; i++) {
+      const di1 = deleteItems1[i]
+      const di2 = deleteItems2[i]
+      if (di1.clock !== di2.clock || di1.len !== di2.len) {
+        t.fail('DeleteSets dont match')
+      }
+    }
+  }
+}
+
+/**
+ * @template T
+ * @callback InitTestObjectCallback
+ * @param {TestYInstance} y
+ * @return {T}
+ */
+
+/**
+ * @template T
+ * @param {t.TestCase} tc
+ * @param {Array<function(Y.Doc,prng.PRNG,T):void>} mods
+ * @param {number} iterations
+ * @param {InitTestObjectCallback<T>} [initTestObject]
+ */
+export const applyRandomTests = (tc, mods, iterations, initTestObject) => {
+  const gen = tc.prng
+  const result = init(tc, { users: 5 }, initTestObject)
+  const { testConnector, users } = result
+  for (let i = 0; i < iterations; i++) {
+    if (prng.int31(gen, 0, 100) <= 2) {
+      // 2% chance to disconnect/reconnect a random user
+      if (prng.bool(gen)) {
+        testConnector.disconnectRandom()
+      } else {
+        testConnector.reconnectRandom()
+      }
+    } else if (prng.int31(gen, 0, 100) <= 1) {
+      // 1% chance to flush all
+      testConnector.flushAllMessages()
+    } else if (prng.int31(gen, 0, 100) <= 50) {
+      // 50% chance to flush a random message
+      testConnector.flushRandomMessage()
+    }
+    const user = prng.int31(gen, 0, users.length - 1)
+    const test = prng.oneOf(gen, mods)
+    test(users[user], gen, result.testObjects[user])
+  }
+  compare(users)
+  return result
+}

tests/undo-redo.tests.js

@@ -0,0 +1,248 @@
+import { init, compare, applyRandomTests, Doc } from './testHelper.js' // eslint-disable-line
+
+import {
+  UndoManager
+} from '../src/internals.js'
+
+import * as Y from '../src/index.js'
+import * as t from 'lib0/testing.js'
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoText = tc => {
+  const { testConnector, text0, text1 } = init(tc, { users: 3 })
+  const undoManager = new UndoManager(text0)
+
+  // items that are added & deleted in the same transaction won't be undo
+  text0.insert(0, 'test')
+  text0.delete(0, 4)
+  undoManager.undo()
+  t.assert(text0.toString() === '')
+
+  // follow redone items
+  text0.insert(0, 'a')
+  undoManager.stopCapturing()
+  text0.delete(0, 1)
+  undoManager.stopCapturing()
+  undoManager.undo()
+  t.assert(text0.toString() === 'a')
+  undoManager.undo()
+  t.assert(text0.toString() === '')
+
+  text0.insert(0, 'abc')
+  text1.insert(0, 'xyz')
+  testConnector.syncAll()
+  undoManager.undo()
+  t.assert(text0.toString() === 'xyz')
+  undoManager.redo()
+  t.assert(text0.toString() === 'abcxyz')
+  testConnector.syncAll()
+  text1.delete(0, 1)
+  testConnector.syncAll()
+  undoManager.undo()
+  t.assert(text0.toString() === 'xyz')
+  undoManager.redo()
+  t.assert(text0.toString() === 'bcxyz')
+  // test marks
+  text0.format(1, 3, { bold: true })
+  t.compare(text0.toDelta(), [{ insert: 'b' }, { insert: 'cxy', attributes: { bold: true } }, { insert: 'z' }])
+  undoManager.undo()
+  t.compare(text0.toDelta(), [{ insert: 'bcxyz' }])
+  undoManager.redo()
+  t.compare(text0.toDelta(), [{ insert: 'b' }, { insert: 'cxy', attributes: { bold: true } }, { insert: 'z' }])
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoMap = tc => {
+  const { testConnector, map0, map1 } = init(tc, { users: 2 })
+  map0.set('a', 0)
+  const undoManager = new UndoManager(map0)
+  map0.set('a', 1)
+  undoManager.undo()
+  t.assert(map0.get('a') === 0)
+  undoManager.redo()
+  t.assert(map0.get('a') === 1)
+  // testing sub-types and if it can restore a whole type
+  const subType = new Y.Map()
+  map0.set('a', subType)
+  subType.set('x', 42)
+  t.compare(map0.toJSON(), /** @type {any} */ ({ a: { x: 42 } }))
+  undoManager.undo()
+  t.assert(map0.get('a') === 1)
+  undoManager.redo()
+  t.compare(map0.toJSON(), /** @type {any} */ ({ a: { x: 42 } }))
+  testConnector.syncAll()
+  // if content is overwritten by another user, undo operations should be skipped
+  map1.set('a', 44)
+  testConnector.syncAll()
+  undoManager.undo()
+  t.assert(map0.get('a') === 44)
+  undoManager.redo()
+  t.assert(map0.get('a') === 44)
+
+  // test setting value multiple times
+  map0.set('b', 'initial')
+  undoManager.stopCapturing()
+  map0.set('b', 'val1')
+  map0.set('b', 'val2')
+  undoManager.stopCapturing()
+  undoManager.undo()
+  t.assert(map0.get('b') === 'initial')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoArray = tc => {
+  const { testConnector, array0, array1 } = init(tc, { users: 3 })
+  const undoManager = new UndoManager(array0)
+  array0.insert(0, [1, 2, 3])
+  array1.insert(0, [4, 5, 6])
+  testConnector.syncAll()
+  t.compare(array0.toArray(), [1, 2, 3, 4, 5, 6])
+  undoManager.undo()
+  t.compare(array0.toArray(), [4, 5, 6])
+  undoManager.redo()
+  t.compare(array0.toArray(), [1, 2, 3, 4, 5, 6])
+  testConnector.syncAll()
+  array1.delete(0, 1) // user1 deletes [1]
+  testConnector.syncAll()
+  undoManager.undo()
+  t.compare(array0.toArray(), [4, 5, 6])
+  undoManager.redo()
+  t.compare(array0.toArray(), [2, 3, 4, 5, 6])
+  array0.delete(0, 5)
+  // test nested structure
+  const ymap = new Y.Map()
+  array0.insert(0, [ymap])
+  t.compare(array0.toJSON(), [{}])
+  undoManager.stopCapturing()
+  ymap.set('a', 1)
+  t.compare(array0.toJSON(), [{ a: 1 }])
+  undoManager.undo()
+  t.compare(array0.toJSON(), [{}])
+  undoManager.undo()
+  t.compare(array0.toJSON(), [2, 3, 4, 5, 6])
+  undoManager.redo()
+  t.compare(array0.toJSON(), [{}])
+  undoManager.redo()
+  t.compare(array0.toJSON(), [{ a: 1 }])
+  testConnector.syncAll()
+  array1.get(0).set('b', 2)
+  testConnector.syncAll()
+  t.compare(array0.toJSON(), [{ a: 1, b: 2 }])
+  undoManager.undo()
+  t.compare(array0.toJSON(), [{ b: 2 }])
+  undoManager.undo()
+  t.compare(array0.toJSON(), [2, 3, 4, 5, 6])
+  undoManager.redo()
+  t.compare(array0.toJSON(), [{ b: 2 }])
+  undoManager.redo()
+  t.compare(array0.toJSON(), [{ a: 1, b: 2 }])
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoXml = tc => {
+  const { xml0 } = init(tc, { users: 3 })
+  const undoManager = new UndoManager(xml0)
+  const child = new Y.XmlElement('p')
+  xml0.insert(0, [child])
+  const textchild = new Y.XmlText('content')
+  child.insert(0, [textchild])
+  t.assert(xml0.toString() === '<undefined><p>content</p></undefined>')
+  // format textchild and revert that change
+  undoManager.stopCapturing()
+  textchild.format(3, 4, { bold: {} })
+  t.assert(xml0.toString() === '<undefined><p>con<bold>tent</bold></p></undefined>')
+  undoManager.undo()
+  t.assert(xml0.toString() === '<undefined><p>content</p></undefined>')
+  undoManager.redo()
+  t.assert(xml0.toString() === '<undefined><p>con<bold>tent</bold></p></undefined>')
+  xml0.delete(0, 1)
+  t.assert(xml0.toString() === '<undefined></undefined>')
+  undoManager.undo()
+  t.assert(xml0.toString() === '<undefined><p>con<bold>tent</bold></p></undefined>')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoEvents = tc => {
+  const { text0 } = init(tc, { users: 3 })
+  const undoManager = new UndoManager(text0)
+  let counter = 0
+  let receivedMetadata = -1
+  undoManager.on('stack-item-added', /** @param {any} event */ event => {
+    t.assert(event.type != null)
+    event.stackItem.meta.set('test', counter++)
+  })
+  undoManager.on('stack-item-popped', /** @param {any} event */ event => {
+    t.assert(event.type != null)
+    receivedMetadata = event.stackItem.meta.get('test')
+  })
+  text0.insert(0, 'abc')
+  undoManager.undo()
+  t.assert(receivedMetadata === 0)
+  undoManager.redo()
+  t.assert(receivedMetadata === 1)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testTrackClass = tc => {
+  const { users, text0 } = init(tc, { users: 3 })
+  // only track origins that are numbers
+  const undoManager = new UndoManager(text0, { trackedOrigins: new Set([Number]) })
+  users[0].transact(() => {
+    text0.insert(0, 'abc')
+  }, 42)
+  t.assert(text0.toString() === 'abc')
+  undoManager.undo()
+  t.assert(text0.toString() === '')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testTypeScope = tc => {
+  const { array0 } = init(tc, { users: 3 })
+  // only track origins that are numbers
+  const text0 = new Y.Text()
+  const text1 = new Y.Text()
+  array0.insert(0, [text0, text1])
+  const undoManager = new UndoManager(text0)
+  const undoManagerBoth = new UndoManager([text0, text1])
+  text1.insert(0, 'abc')
+  t.assert(undoManager.undoStack.length === 0)
+  t.assert(undoManagerBoth.undoStack.length === 1)
+  t.assert(text1.toString() === 'abc')
+  undoManager.undo()
+  t.assert(text1.toString() === 'abc')
+  undoManagerBoth.undo()
+  t.assert(text1.toString() === '')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testUndoDeleteFilter = tc => {
+  /**
+   * @type {Array<Y.Map<any>>}
+   */
+  const array0 = /** @type {any} */ (init(tc, { users: 3 }).array0)
+  const undoManager = new UndoManager(array0, { deleteFilter: item => !(item instanceof Y.Item) || (item.content instanceof Y.ContentType && item.content.type._map.size === 0) })
+  const map0 = new Y.Map()
+  map0.set('hi', 1)
+  const map1 = new Y.Map()
+  array0.insert(0, [map0, map1])
+  undoManager.undo()
+  t.assert(array0.length === 1)
+  array0.get(0)
+  t.assert(Array.from(array0.get(0).keys()).length === 1)
+}

tests/y-array.tests.js

@@ -0,0 +1,494 @@
+import { init, compare, applyRandomTests, Doc } from './testHelper.js' // eslint-disable-line
+
+import * as Y from '../src/index.js'
+import * as t from 'lib0/testing.js'
+import * as prng from 'lib0/prng.js'
+import * as math from 'lib0/math.js'
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testDeleteInsert = tc => {
+  const { users, array0 } = init(tc, { users: 2 })
+  array0.delete(0, 0)
+  t.describe('Does not throw when deleting zero elements with position 0')
+  t.fails(() => {
+    array0.delete(1, 1)
+  })
+  array0.insert(0, ['A'])
+  array0.delete(1, 0)
+  t.describe('Does not throw when deleting zero elements with valid position 1')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertThreeElementsTryRegetProperty = tc => {
+  const { testConnector, users, array0, array1 } = init(tc, { users: 2 })
+  array0.insert(0, [1, true, false])
+  t.compare(array0.toJSON(), [1, true, false], '.toJSON() works')
+  testConnector.flushAllMessages()
+  t.compare(array1.toJSON(), [1, true, false], '.toJSON() works after sync')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testConcurrentInsertWithThreeConflicts = tc => {
+  var { users, array0, array1, array2 } = init(tc, { users: 3 })
+  array0.insert(0, [0])
+  array1.insert(0, [1])
+  array2.insert(0, [2])
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testConcurrentInsertDeleteWithThreeConflicts = tc => {
+  const { testConnector, users, array0, array1, array2 } = init(tc, { users: 3 })
+  array0.insert(0, ['x', 'y', 'z'])
+  testConnector.flushAllMessages()
+  array0.insert(1, [0])
+  array1.delete(0)
+  array1.delete(1, 1)
+  array2.insert(1, [2])
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertionsInLateSync = tc => {
+  const { testConnector, users, array0, array1, array2 } = init(tc, { users: 3 })
+  array0.insert(0, ['x', 'y'])
+  testConnector.flushAllMessages()
+  users[1].disconnect()
+  users[2].disconnect()
+  array0.insert(1, ['user0'])
+  array1.insert(1, ['user1'])
+  array2.insert(1, ['user2'])
+  users[1].connect()
+  users[2].connect()
+  testConnector.flushAllMessages()
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testDisconnectReallyPreventsSendingMessages = tc => {
+  var { testConnector, users, array0, array1 } = init(tc, { users: 3 })
+  array0.insert(0, ['x', 'y'])
+  testConnector.flushAllMessages()
+  users[1].disconnect()
+  users[2].disconnect()
+  array0.insert(1, ['user0'])
+  array1.insert(1, ['user1'])
+  t.compare(array0.toJSON(), ['x', 'user0', 'y'])
+  t.compare(array1.toJSON(), ['x', 'user1', 'y'])
+  users[1].connect()
+  users[2].connect()
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testDeletionsInLateSync = tc => {
+  const { testConnector, users, array0, array1 } = init(tc, { users: 2 })
+  array0.insert(0, ['x', 'y'])
+  testConnector.flushAllMessages()
+  users[1].disconnect()
+  array1.delete(1, 1)
+  array0.delete(0, 2)
+  users[1].connect()
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertThenMergeDeleteOnSync = tc => {
+  const { testConnector, users, array0, array1 } = init(tc, { users: 2 })
+  array0.insert(0, ['x', 'y', 'z'])
+  testConnector.flushAllMessages()
+  users[0].disconnect()
+  array1.delete(0, 3)
+  users[0].connect()
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertAndDeleteEvents = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  /**
+   * @type {Object<string,any>?}
+   */
+  let event = null
+  array0.observe(e => {
+    event = e
+  })
+  array0.insert(0, [0, 1, 2])
+  t.assert(event !== null)
+  event = null
+  array0.delete(0)
+  t.assert(event !== null)
+  event = null
+  array0.delete(0, 2)
+  t.assert(event !== null)
+  event = null
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testNestedObserverEvents = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  /**
+   * @type {Array<number>}
+   */
+  const vals = []
+  array0.observe(e => {
+    if (array0.length === 1) {
+      // inserting, will call this observer again
+      // we expect that this observer is called after this event handler finishedn
+      array0.insert(1, [1])
+      vals.push(0)
+    } else {
+      // this should be called the second time an element is inserted (above case)
+      vals.push(1)
+    }
+  })
+  array0.insert(0, [0])
+  t.compareArrays(vals, [0, 1])
+  t.compareArrays(array0.toArray(), [0, 1])
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertAndDeleteEventsForTypes = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  /**
+   * @type {Object<string,any>|null}
+   */
+  let event = null
+  array0.observe(e => {
+    event = e
+  })
+  array0.insert(0, [new Y.Array()])
+  t.assert(event !== null)
+  event = null
+  array0.delete(0)
+  t.assert(event !== null)
+  event = null
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testChangeEvent = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  /**
+   * @type {any}
+   */
+  let changes = null
+  array0.observe(e => {
+    changes = e.changes
+  })
+  const newArr = new Y.Array()
+  array0.insert(0, [newArr, 4, 'dtrn'])
+  t.assert(changes !== null && changes.added.size === 2 && changes.deleted.size === 0)
+  t.compare(changes.delta, [{ insert: [newArr, 4, 'dtrn'] }])
+  changes = null
+  array0.delete(0, 2)
+  t.assert(changes !== null && changes.added.size === 0 && changes.deleted.size === 2)
+  t.compare(changes.delta, [{ delete: 2 }])
+  changes = null
+  array0.insert(1, [0.1])
+  t.assert(changes !== null && changes.added.size === 1 && changes.deleted.size === 0)
+  t.compare(changes.delta, [{ retain: 1 }, { insert: [0.1] }])
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testInsertAndDeleteEventsForTypes2 = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  /**
+   * @type {Array<Object<string,any>>}
+   */
+  const events = []
+  array0.observe(e => {
+    events.push(e)
+  })
+  array0.insert(0, ['hi', new Y.Map()])
+  t.assert(events.length === 1, 'Event is triggered exactly once for insertion of two elements')
+  array0.delete(1)
+  t.assert(events.length === 2, 'Event is triggered exactly once for deletion')
+  compare(users)
+}
+
+/**
+ * This issue has been reported here https://github.com/yjs/yjs/issues/155
+ * @param {t.TestCase} tc
+ */
+export const testNewChildDoesNotEmitEventInTransaction = tc => {
+  const { array0, users } = init(tc, { users: 2 })
+  let fired = false
+  users[0].transact(() => {
+    const newMap = new Y.Map()
+    newMap.observe(() => {
+      fired = true
+    })
+    array0.insert(0, [newMap])
+    newMap.set('tst', 42)
+  })
+  t.assert(!fired, 'Event does not trigger')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGarbageCollector = tc => {
+  const { testConnector, users, array0 } = init(tc, { users: 3 })
+  array0.insert(0, ['x', 'y', 'z'])
+  testConnector.flushAllMessages()
+  users[0].disconnect()
+  array0.delete(0, 3)
+  users[0].connect()
+  testConnector.flushAllMessages()
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testEventTargetIsSetCorrectlyOnLocal = tc => {
+  const { array0, users } = init(tc, { users: 3 })
+  /**
+   * @type {any}
+   */
+  let event
+  array0.observe(e => {
+    event = e
+  })
+  array0.insert(0, ['stuff'])
+  t.assert(event.target === array0, '"target" property is set correctly')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testEventTargetIsSetCorrectlyOnRemote = tc => {
+  const { testConnector, array0, array1, users } = init(tc, { users: 3 })
+  /**
+   * @type {any}
+   */
+  let event
+  array0.observe(e => {
+    event = e
+  })
+  array1.insert(0, ['stuff'])
+  testConnector.flushAllMessages()
+  t.assert(event.target === array0, '"target" property is set correctly')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testIteratingArrayContainingTypes = tc => {
+  const y = new Y.Doc()
+  const arr = y.getArray('arr')
+  const numItems = 10
+  for (let i = 0; i < numItems; i++) {
+    const map = new Y.Map()
+    map.set('value', i)
+    arr.push([map])
+  }
+  let cnt = 0
+  for (const item of arr) {
+    t.assert(item.get('value') === cnt++, 'value is correct')
+  }
+  y.destroy()
+}
+
+let _uniqueNumber = 0
+const getUniqueNumber = () => _uniqueNumber++
+
+/**
+ * @type {Array<function(Doc,prng.PRNG,any):void>}
+ */
+const arrayTransactions = [
+  function insert (user, gen) {
+    const yarray = user.getArray('array')
+    var uniqueNumber = getUniqueNumber()
+    var content = []
+    var len = prng.int31(gen, 1, 4)
+    for (var i = 0; i < len; i++) {
+      content.push(uniqueNumber)
+    }
+    var pos = prng.int31(gen, 0, yarray.length)
+    yarray.insert(pos, content)
+  },
+  function insertTypeArray (user, gen) {
+    const yarray = user.getArray('array')
+    var pos = prng.int31(gen, 0, yarray.length)
+    yarray.insert(pos, [new Y.Array()])
+    var array2 = yarray.get(pos)
+    array2.insert(0, [1, 2, 3, 4])
+  },
+  function insertTypeMap (user, gen) {
+    const yarray = user.getArray('array')
+    var pos = prng.int31(gen, 0, yarray.length)
+    yarray.insert(pos, [new Y.Map()])
+    var map = yarray.get(pos)
+    map.set('someprop', 42)
+    map.set('someprop', 43)
+    map.set('someprop', 44)
+  },
+  function _delete (user, gen) {
+    const yarray = user.getArray('array')
+    var length = yarray.length
+    if (length > 0) {
+      var somePos = prng.int31(gen, 0, length - 1)
+      var delLength = prng.int31(gen, 1, math.min(2, length - somePos))
+      if (prng.bool(gen)) {
+        var type = yarray.get(somePos)
+        if (type.length > 0) {
+          somePos = prng.int31(gen, 0, type.length - 1)
+          delLength = prng.int31(gen, 0, math.min(2, type.length - somePos))
+          type.delete(somePos, delLength)
+        }
+      } else {
+        yarray.delete(somePos, delLength)
+      }
+    }
+  }
+]
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests4 = tc => {
+  applyRandomTests(tc, arrayTransactions, 4)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests40 = tc => {
+  applyRandomTests(tc, arrayTransactions, 40)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests42 = tc => {
+  applyRandomTests(tc, arrayTransactions, 42)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests43 = tc => {
+  applyRandomTests(tc, arrayTransactions, 43)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests44 = tc => {
+  applyRandomTests(tc, arrayTransactions, 44)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests45 = tc => {
+  applyRandomTests(tc, arrayTransactions, 45)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests46 = tc => {
+  applyRandomTests(tc, arrayTransactions, 46)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests300 = tc => {
+  applyRandomTests(tc, arrayTransactions, 300)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests400 = tc => {
+  applyRandomTests(tc, arrayTransactions, 400)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests500 = tc => {
+  applyRandomTests(tc, arrayTransactions, 500)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests600 = tc => {
+  applyRandomTests(tc, arrayTransactions, 600)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests1000 = tc => {
+  applyRandomTests(tc, arrayTransactions, 1000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests1800 = tc => {
+  applyRandomTests(tc, arrayTransactions, 1800)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests3000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, arrayTransactions, 3000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests5000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, arrayTransactions, 5000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYarrayTests30000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, arrayTransactions, 30000)
+}

tests/y-map.tests.js

@@ -0,0 +1,566 @@
+import { init, compare, applyRandomTests, Doc } from './testHelper.js' // eslint-disable-line
+
+import {
+  compareIDs
+} from '../src/internals.js'
+
+import * as Y from '../src/index.js'
+import * as t from 'lib0/testing.js'
+import * as prng from 'lib0/prng.js'
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testBasicMapTests = tc => {
+  const { testConnector, users, map0, map1, map2 } = init(tc, { users: 3 })
+  users[2].disconnect()
+
+  map0.set('number', 1)
+  map0.set('string', 'hello Y')
+  map0.set('object', { key: { key2: 'value' } })
+  map0.set('y-map', new Y.Map())
+  map0.set('boolean1', true)
+  map0.set('boolean0', false)
+  const map = map0.get('y-map')
+  map.set('y-array', new Y.Array())
+  const array = map.get('y-array')
+  array.insert(0, [0])
+  array.insert(0, [-1])
+
+  t.assert(map0.get('number') === 1, 'client 0 computed the change (number)')
+  t.assert(map0.get('string') === 'hello Y', 'client 0 computed the change (string)')
+  t.assert(map0.get('boolean0') === false, 'client 0 computed the change (boolean)')
+  t.assert(map0.get('boolean1') === true, 'client 0 computed the change (boolean)')
+  t.compare(map0.get('object'), { key: { key2: 'value' } }, 'client 0 computed the change (object)')
+  t.assert(map0.get('y-map').get('y-array').get(0) === -1, 'client 0 computed the change (type)')
+
+  users[2].connect()
+  testConnector.flushAllMessages()
+
+  t.assert(map1.get('number') === 1, 'client 1 received the update (number)')
+  t.assert(map1.get('string') === 'hello Y', 'client 1 received the update (string)')
+  t.assert(map1.get('boolean0') === false, 'client 1 computed the change (boolean)')
+  t.assert(map1.get('boolean1') === true, 'client 1 computed the change (boolean)')
+  t.compare(map1.get('object'), { key: { key2: 'value' } }, 'client 1 received the update (object)')
+  t.assert(map1.get('y-map').get('y-array').get(0) === -1, 'client 1 received the update (type)')
+
+  // compare disconnected user
+  t.assert(map2.get('number') === 1, 'client 2 received the update (number) - was disconnected')
+  t.assert(map2.get('string') === 'hello Y', 'client 2 received the update (string) - was disconnected')
+  t.assert(map2.get('boolean0') === false, 'client 2 computed the change (boolean)')
+  t.assert(map2.get('boolean1') === true, 'client 2 computed the change (boolean)')
+  t.compare(map2.get('object'), { key: { key2: 'value' } }, 'client 2 received the update (object) - was disconnected')
+  t.assert(map2.get('y-map').get('y-array').get(0) === -1, 'client 2 received the update (type) - was disconnected')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetOfMapProperty = tc => {
+  const { testConnector, users, map0 } = init(tc, { users: 2 })
+  map0.set('stuff', 'stuffy')
+  map0.set('undefined', undefined)
+  map0.set('null', null)
+  t.compare(map0.get('stuff'), 'stuffy')
+
+  testConnector.flushAllMessages()
+
+  for (const user of users) {
+    const u = user.getMap('map')
+    t.compare(u.get('stuff'), 'stuffy')
+    t.assert(u.get('undefined') === undefined, 'undefined')
+    t.compare(u.get('null'), null, 'null')
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testYmapSetsYmap = tc => {
+  const { users, map0 } = init(tc, { users: 2 })
+  const map = map0.set('Map', new Y.Map())
+  t.assert(map0.get('Map') === map)
+  map.set('one', 1)
+  t.compare(map.get('one'), 1)
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testYmapSetsYarray = tc => {
+  const { users, map0 } = init(tc, { users: 2 })
+  const array = map0.set('Array', new Y.Array())
+  t.assert(array === map0.get('Array'))
+  array.insert(0, [1, 2, 3])
+  // @ts-ignore
+  t.compare(map0.toJSON(), { Array: [1, 2, 3] })
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetOfMapPropertySyncs = tc => {
+  const { testConnector, users, map0 } = init(tc, { users: 2 })
+  map0.set('stuff', 'stuffy')
+  t.compare(map0.get('stuff'), 'stuffy')
+  testConnector.flushAllMessages()
+  for (const user of users) {
+    var u = user.getMap('map')
+    t.compare(u.get('stuff'), 'stuffy')
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetOfMapPropertyWithConflict = tc => {
+  const { testConnector, users, map0, map1 } = init(tc, { users: 3 })
+  map0.set('stuff', 'c0')
+  map1.set('stuff', 'c1')
+  testConnector.flushAllMessages()
+  for (const user of users) {
+    var u = user.getMap('map')
+    t.compare(u.get('stuff'), 'c1')
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetAndDeleteOfMapProperty = tc => {
+  const { testConnector, users, map0, map1 } = init(tc, { users: 3 })
+  map0.set('stuff', 'c0')
+  map1.set('stuff', 'c1')
+  map1.delete('stuff')
+  testConnector.flushAllMessages()
+  for (const user of users) {
+    var u = user.getMap('map')
+    t.assert(u.get('stuff') === undefined)
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetOfMapPropertyWithThreeConflicts = tc => {
+  const { testConnector, users, map0, map1, map2 } = init(tc, { users: 3 })
+  map0.set('stuff', 'c0')
+  map1.set('stuff', 'c1')
+  map1.set('stuff', 'c2')
+  map2.set('stuff', 'c3')
+  testConnector.flushAllMessages()
+  for (const user of users) {
+    var u = user.getMap('map')
+    t.compare(u.get('stuff'), 'c3')
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetAndSetAndDeleteOfMapPropertyWithThreeConflicts = tc => {
+  const { testConnector, users, map0, map1, map2, map3 } = init(tc, { users: 4 })
+  map0.set('stuff', 'c0')
+  map1.set('stuff', 'c1')
+  map1.set('stuff', 'c2')
+  map2.set('stuff', 'c3')
+  testConnector.flushAllMessages()
+  map0.set('stuff', 'deleteme')
+  map1.set('stuff', 'c1')
+  map2.set('stuff', 'c2')
+  map3.set('stuff', 'c3')
+  map3.delete('stuff')
+  testConnector.flushAllMessages()
+  for (const user of users) {
+    var u = user.getMap('map')
+    t.assert(u.get('stuff') === undefined)
+  }
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testObserveDeepProperties = tc => {
+  const { testConnector, users, map1, map2, map3 } = init(tc, { users: 4 })
+  const _map1 = map1.set('map', new Y.Map())
+  let calls = 0
+  let dmapid
+  map1.observeDeep(events => {
+    events.forEach(event => {
+      calls++
+      // @ts-ignore
+      t.assert(event.keysChanged.has('deepmap'))
+      t.assert(event.path.length === 1)
+      t.assert(event.path[0] === 'map')
+      // @ts-ignore
+      dmapid = event.target.get('deepmap')._item.id
+    })
+  })
+  testConnector.flushAllMessages()
+  const _map3 = map3.get('map')
+  _map3.set('deepmap', new Y.Map())
+  testConnector.flushAllMessages()
+  const _map2 = map2.get('map')
+  _map2.set('deepmap', new Y.Map())
+  testConnector.flushAllMessages()
+  const dmap1 = _map1.get('deepmap')
+  const dmap2 = _map2.get('deepmap')
+  const dmap3 = _map3.get('deepmap')
+  t.assert(calls > 0)
+  t.assert(compareIDs(dmap1._item.id, dmap2._item.id))
+  t.assert(compareIDs(dmap1._item.id, dmap3._item.id))
+  // @ts-ignore we want the possibility of dmapid being undefined
+  t.assert(compareIDs(dmap1._item.id, dmapid))
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testObserversUsingObservedeep = tc => {
+  const { users, map0 } = init(tc, { users: 2 })
+  /**
+   * @type {Array<Array<string|number>>}
+   */
+  const pathes = []
+  let calls = 0
+  map0.observeDeep(events => {
+    events.forEach(event => {
+      pathes.push(event.path)
+    })
+    calls++
+  })
+  map0.set('map', new Y.Map())
+  map0.get('map').set('array', new Y.Array())
+  map0.get('map').get('array').insert(0, ['content'])
+  t.assert(calls === 3)
+  t.compare(pathes, [[], ['map'], ['map', 'array']])
+  compare(users)
+}
+
+// TODO: Test events in Y.Map
+/**
+ * @param {Object<string,any>} is
+ * @param {Object<string,any>} should
+ */
+const compareEvent = (is, should) => {
+  for (var key in should) {
+    t.compare(should[key], is[key])
+  }
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testThrowsAddAndUpdateAndDeleteEvents = tc => {
+  const { users, map0 } = init(tc, { users: 2 })
+  /**
+   * @type {Object<string,any>}
+   */
+  let event = {}
+  map0.observe(e => {
+    event = e // just put it on event, should be thrown synchronously anyway
+  })
+  map0.set('stuff', 4)
+  compareEvent(event, {
+    target: map0,
+    keysChanged: new Set(['stuff'])
+  })
+  // update, oldValue is in contents
+  map0.set('stuff', new Y.Array())
+  compareEvent(event, {
+    target: map0,
+    keysChanged: new Set(['stuff'])
+  })
+  // update, oldValue is in opContents
+  map0.set('stuff', 5)
+  // delete
+  map0.delete('stuff')
+  compareEvent(event, {
+    keysChanged: new Set(['stuff']),
+    target: map0
+  })
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testChangeEvent = tc => {
+  const { map0, users } = init(tc, { users: 2 })
+  /**
+   * @type {any}
+   */
+  let changes = null
+  /**
+   * @type {any}
+   */
+  let keyChange = null
+  map0.observe(e => {
+    changes = e.changes
+  })
+  map0.set('a', 1)
+  keyChange = changes.keys.get('a')
+  t.assert(changes !== null && keyChange.action === 'add' && keyChange.oldValue === undefined)
+  map0.set('a', 2)
+  keyChange = changes.keys.get('a')
+  t.assert(changes !== null && keyChange.action === 'update' && keyChange.oldValue === 1)
+  users[0].transact(() => {
+    map0.set('a', 3)
+    map0.set('a', 4)
+  })
+  keyChange = changes.keys.get('a')
+  t.assert(changes !== null && keyChange.action === 'update' && keyChange.oldValue === 2)
+  users[0].transact(() => {
+    map0.set('b', 1)
+    map0.set('b', 2)
+  })
+  keyChange = changes.keys.get('b')
+  t.assert(changes !== null && keyChange.action === 'add' && keyChange.oldValue === undefined)
+  users[0].transact(() => {
+    map0.set('c', 1)
+    map0.delete('c')
+  })
+  t.assert(changes !== null && changes.keys.size === 0)
+  users[0].transact(() => {
+    map0.set('d', 1)
+    map0.set('d', 2)
+  })
+  keyChange = changes.keys.get('d')
+  t.assert(changes !== null && keyChange.action === 'add' && keyChange.oldValue === undefined)
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testYmapEventExceptionsShouldCompleteTransaction = tc => {
+  const doc = new Y.Doc()
+  const map = doc.getMap('map')
+
+  let updateCalled = false
+  let throwingObserverCalled = false
+  let throwingDeepObserverCalled = false
+  doc.on('update', () => {
+    updateCalled = true
+  })
+
+  const throwingObserver = () => {
+    throwingObserverCalled = true
+    throw new Error('Failure')
+  }
+
+  const throwingDeepObserver = () => {
+    throwingDeepObserverCalled = true
+    throw new Error('Failure')
+  }
+
+  map.observe(throwingObserver)
+  map.observeDeep(throwingDeepObserver)
+
+  t.fails(() => {
+    map.set('y', '2')
+  })
+
+  t.assert(updateCalled)
+  t.assert(throwingObserverCalled)
+  t.assert(throwingDeepObserverCalled)
+
+  // check if it works again
+  updateCalled = false
+  throwingObserverCalled = false
+  throwingDeepObserverCalled = false
+  t.fails(() => {
+    map.set('z', '3')
+  })
+
+  t.assert(updateCalled)
+  t.assert(throwingObserverCalled)
+  t.assert(throwingDeepObserverCalled)
+
+  t.assert(map.get('z') === '3')
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testYmapEventHasCorrectValueWhenSettingAPrimitive = tc => {
+  const { users, map0 } = init(tc, { users: 3 })
+  /**
+   * @type {Object<string,any>}
+   */
+  let event = {}
+  map0.observe(e => {
+    event = e
+  })
+  map0.set('stuff', 2)
+  t.compare(event.value, event.target.get(event.name))
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testYmapEventHasCorrectValueWhenSettingAPrimitiveFromOtherUser = tc => {
+  const { users, map0, map1, testConnector } = init(tc, { users: 3 })
+  /**
+   * @type {Object<string,any>}
+   */
+  let event = {}
+  map0.observe(e => {
+    event = e
+  })
+  map1.set('stuff', 2)
+  testConnector.flushAllMessages()
+  t.compare(event.value, event.target.get(event.name))
+  compare(users)
+}
+
+/**
+ * @type {Array<function(Doc,prng.PRNG):void>}
+ */
+const mapTransactions = [
+  function set (user, gen) {
+    const key = prng.oneOf(gen, ['one', 'two'])
+    var value = prng.utf16String(gen)
+    user.getMap('map').set(key, value)
+  },
+  function setType (user, gen) {
+    const key = prng.oneOf(gen, ['one', 'two'])
+    var type = prng.oneOf(gen, [new Y.Array(), new Y.Map()])
+    user.getMap('map').set(key, type)
+    if (type instanceof Y.Array) {
+      type.insert(0, [1, 2, 3, 4])
+    } else {
+      type.set('deepkey', 'deepvalue')
+    }
+  },
+  function _delete (user, gen) {
+    const key = prng.oneOf(gen, ['one', 'two'])
+    user.getMap('map').delete(key)
+  }
+]
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests10 = tc => {
+  applyRandomTests(tc, mapTransactions, 10)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests40 = tc => {
+  applyRandomTests(tc, mapTransactions, 40)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests42 = tc => {
+  applyRandomTests(tc, mapTransactions, 42)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests43 = tc => {
+  applyRandomTests(tc, mapTransactions, 43)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests44 = tc => {
+  applyRandomTests(tc, mapTransactions, 44)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests45 = tc => {
+  applyRandomTests(tc, mapTransactions, 45)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests46 = tc => {
+  applyRandomTests(tc, mapTransactions, 46)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests300 = tc => {
+  applyRandomTests(tc, mapTransactions, 300)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests400 = tc => {
+  applyRandomTests(tc, mapTransactions, 400)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests500 = tc => {
+  applyRandomTests(tc, mapTransactions, 500)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests600 = tc => {
+  applyRandomTests(tc, mapTransactions, 600)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests1000 = tc => {
+  applyRandomTests(tc, mapTransactions, 1000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests1800 = tc => {
+  applyRandomTests(tc, mapTransactions, 1800)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests5000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, mapTransactions, 5000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests10000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, mapTransactions, 10000)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testRepeatGeneratingYmapTests100000 = tc => {
+  t.skip(!t.production)
+  applyRandomTests(tc, mapTransactions, 100000)
+}

tests/y-text.tests.js

@@ -0,0 +1,160 @@
+import * as Y from './testHelper.js'
+import * as t from 'lib0/testing.js'
+const { init, compare } = Y
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testBasicInsertAndDelete = tc => {
+  const { users, text0 } = init(tc, { users: 2 })
+  let delta
+
+  text0.observe(event => {
+    delta = event.delta
+  })
+
+  text0.delete(0, 0)
+  t.assert(true, 'Does not throw when deleting zero elements with position 0')
+
+  text0.insert(0, 'abc')
+  t.assert(text0.toString() === 'abc', 'Basic insert works')
+  t.compare(delta, [{ insert: 'abc' }])
+
+  text0.delete(0, 1)
+  t.assert(text0.toString() === 'bc', 'Basic delete works (position 0)')
+  t.compare(delta, [{ delete: 1 }])
+
+  text0.delete(1, 1)
+  t.assert(text0.toString() === 'b', 'Basic delete works (position 1)')
+  t.compare(delta, [{ retain: 1 }, { delete: 1 }])
+
+  users[0].transact(() => {
+    text0.insert(0, '1')
+    text0.delete(0, 1)
+  })
+  t.compare(delta, [])
+
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testBasicFormat = tc => {
+  const { users, text0 } = init(tc, { users: 2 })
+  let delta
+  text0.observe(event => {
+    delta = event.delta
+  })
+  text0.insert(0, 'abc', { bold: true })
+  t.assert(text0.toString() === 'abc', 'Basic insert with attributes works')
+  t.compare(text0.toDelta(), [{ insert: 'abc', attributes: { bold: true } }])
+  t.compare(delta, [{ insert: 'abc', attributes: { bold: true } }])
+  text0.delete(0, 1)
+  t.assert(text0.toString() === 'bc', 'Basic delete on formatted works (position 0)')
+  t.compare(text0.toDelta(), [{ insert: 'bc', attributes: { bold: true } }])
+  t.compare(delta, [{ delete: 1 }])
+  text0.delete(1, 1)
+  t.assert(text0.toString() === 'b', 'Basic delete works (position 1)')
+  t.compare(text0.toDelta(), [{ insert: 'b', attributes: { bold: true } }])
+  t.compare(delta, [{ retain: 1 }, { delete: 1 }])
+  text0.insert(0, 'z', { bold: true })
+  t.assert(text0.toString() === 'zb')
+  t.compare(text0.toDelta(), [{ insert: 'zb', attributes: { bold: true } }])
+  t.compare(delta, [{ insert: 'z', attributes: { bold: true } }])
+  // @ts-ignore
+  t.assert(text0._start.right.right.right.content.str === 'b', 'Does not insert duplicate attribute marker')
+  text0.insert(0, 'y')
+  t.assert(text0.toString() === 'yzb')
+  t.compare(text0.toDelta(), [{ insert: 'y' }, { insert: 'zb', attributes: { bold: true } }])
+  t.compare(delta, [{ insert: 'y' }])
+  text0.format(0, 2, { bold: null })
+  t.assert(text0.toString() === 'yzb')
+  t.compare(text0.toDelta(), [{ insert: 'yz' }, { insert: 'b', attributes: { bold: true } }])
+  t.compare(delta, [{ retain: 1 }, { retain: 1, attributes: { bold: null } }])
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testGetDeltaWithEmbeds = tc => {
+  const { text0 } = init(tc, { users: 1 })
+  text0.applyDelta([{
+    insert: { linebreak: 's' }
+  }])
+  t.compare(text0.toDelta(), [{
+    insert: { linebreak: 's' }
+  }])
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testSnapshot = tc => {
+  const { text0 } = init(tc, { users: 1 })
+  const doc0 = /** @type {Y.Doc} */ (text0.doc)
+  doc0.gc = false
+  text0.applyDelta([{
+    insert: 'abcd'
+  }])
+  const snapshot1 = Y.snapshot(doc0)
+  text0.applyDelta([{
+    retain: 1
+  }, {
+    insert: 'x'
+  }, {
+    delete: 1
+  }])
+  const snapshot2 = Y.snapshot(doc0)
+  text0.applyDelta([{
+    retain: 2
+  }, {
+    delete: 3
+  }, {
+    insert: 'x'
+  }, {
+    delete: 1
+  }])
+  const state1 = text0.toDelta(snapshot1)
+  t.compare(state1, [{ insert: 'abcd' }])
+  const state2 = text0.toDelta(snapshot2)
+  t.compare(state2, [{ insert: 'axcd' }])
+  const state2Diff = text0.toDelta(snapshot2, snapshot1)
+  // @ts-ignore Remove userid info
+  state2Diff.forEach(v => {
+    if (v.attributes && v.attributes.ychange) {
+      delete v.attributes.ychange.user
+    }
+  })
+  t.compare(state2Diff, [{ insert: 'a' }, { insert: 'x', attributes: { ychange: { type: 'added' } } }, { insert: 'b', attributes: { ychange: { type: 'removed' } } }, { insert: 'cd' }])
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testSnapshotDeleteAfter = tc => {
+  const { text0 } = init(tc, { users: 1 })
+  const doc0 = /** @type {Y.Doc} */ (text0.doc)
+  doc0.gc = false
+  text0.applyDelta([{
+    insert: 'abcd'
+  }])
+  const snapshot1 = Y.snapshot(doc0)
+  text0.applyDelta([{
+    retain: 4
+  }, {
+    insert: 'e'
+  }])
+  const state1 = text0.toDelta(snapshot1)
+  t.compare(state1, [{ insert: 'abcd' }])
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testToJson = tc => {
+  const { text0 } = init(tc, { users: 1 })
+  text0.insert(0, 'abc', { bold: true })
+  t.assert(text0.toJSON() === 'abc', 'toJSON returns the unformatted text')
+}

tests/y-xml.tests.js

@@ -0,0 +1,75 @@
+import { init, compare } from './testHelper.js'
+import * as Y from '../src/index.js'
+
+import * as t from 'lib0/testing.js'
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testSetProperty = tc => {
+  const { testConnector, users, xml0, xml1 } = init(tc, { users: 2 })
+  xml0.setAttribute('height', '10')
+  t.assert(xml0.getAttribute('height') === '10', 'Simple set+get works')
+  testConnector.flushAllMessages()
+  t.assert(xml1.getAttribute('height') === '10', 'Simple set+get works (remote)')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testEvents = tc => {
+  const { testConnector, users, xml0, xml1 } = init(tc, { users: 2 })
+  /**
+   * @type {any}
+   */
+  let event
+  /**
+   * @type {any}
+   */
+  let remoteEvent
+  xml0.observe(e => {
+    event = e
+  })
+  xml1.observe(e => {
+    remoteEvent = e
+  })
+  xml0.setAttribute('key', 'value')
+  t.assert(event.attributesChanged.has('key'), 'YXmlEvent.attributesChanged on updated key')
+  testConnector.flushAllMessages()
+  t.assert(remoteEvent.attributesChanged.has('key'), 'YXmlEvent.attributesChanged on updated key (remote)')
+  // check attributeRemoved
+  xml0.removeAttribute('key')
+  t.assert(event.attributesChanged.has('key'), 'YXmlEvent.attributesChanged on removed attribute')
+  testConnector.flushAllMessages()
+  t.assert(remoteEvent.attributesChanged.has('key'), 'YXmlEvent.attributesChanged on removed attribute (remote)')
+  xml0.insert(0, [new Y.XmlText('some text')])
+  t.assert(event.childListChanged, 'YXmlEvent.childListChanged on inserted element')
+  testConnector.flushAllMessages()
+  t.assert(remoteEvent.childListChanged, 'YXmlEvent.childListChanged on inserted element (remote)')
+  // test childRemoved
+  xml0.delete(0)
+  t.assert(event.childListChanged, 'YXmlEvent.childListChanged on deleted element')
+  testConnector.flushAllMessages()
+  t.assert(remoteEvent.childListChanged, 'YXmlEvent.childListChanged on deleted element (remote)')
+  compare(users)
+}
+
+/**
+ * @param {t.TestCase} tc
+ */
+export const testTreewalker = tc => {
+  const { users, xml0 } = init(tc, { users: 3 })
+  const paragraph1 = new Y.XmlElement('p')
+  const paragraph2 = new Y.XmlElement('p')
+  const text1 = new Y.XmlText('init')
+  const text2 = new Y.XmlText('text')
+  paragraph1.insert(0, [text1, text2])
+  xml0.insert(0, [paragraph1, paragraph2, new Y.XmlElement('img')])
+  const allParagraphs = xml0.querySelectorAll('p')
+  t.assert(allParagraphs.length === 2, 'found exactly two paragraphs')
+  t.assert(allParagraphs[0] === paragraph1, 'querySelectorAll found paragraph1')
+  t.assert(allParagraphs[1] === paragraph2, 'querySelectorAll found paragraph2')
+  t.assert(xml0.querySelector('p') === paragraph1, 'querySelector found paragraph1')
+  compare(users)
+}

tsconfig.json

@@ -0,0 +1,68 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es2018",
+    "lib": ["es2018", "dom"],                             /* Specify library files to be included in the compilation. */
+    "allowJs": true,                       /* Allow javascript files to be compiled. */
+    "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./dist/yjs.js",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                        /* Redirect output structure to the directory. */
+    "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    "emitDeclarationOnly": true,
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    "paths": {
+      "yjs": ["./src/index.js"],
+      "lib0/*": ["node_modules/lib0/*"],
+      "lib0/set.js": ["node_modules/lib0/set.js"],
+      "lib0/function.js": ["node_modules/lib0/function.js"]
+    },                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    "maxNodeModuleJsDepth": 5,
+    // "types": ["./src/utils/typedefs.js"]
+  },
+  "include": ["./src/**/*.js", "./tests/**/*.js"],
+  "exclude": ["../lib0/**/*", "node_modules/**/*", "dist", "dist/**/*.js"]
+}

y-object.html

@@ -1,7 +0,0 @@
-
-<polymer-element name="y-object" hidden attributes="val connector y">
-</polymer-element>
-<polymer-element name="y-property" hidden attributes="val name y">
-</polymer-element>
-
-<script src="./y-object.js"></script>