Deploy 12.0.1

Deploy 12.0.0
update examples
2016-09-27 16:17:27 +02:00 · 2016-09-20 19:19:14 +02:00 · 2016-09-20 18:29:19 +02:00 · 2016-08-29 17:47:38 +02:00 · 2016-08-22 12:57:04 +02:00 · 2016-08-22 12:15:16 +02:00
21 changed files with 2268 additions and 5753 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1 @@
-node_modules
-Examples/bower_components
-.directory
-.codio
-.settings
-.jshintignore
-.jshintrc
-.validate.json
+bower_components
--- a/Examples/Ace/index.html
+++ b/Examples/Ace/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <style type="text/css" media="screen">
+    #ace { 
+        position: absolute;
+        top: 0;
+        right: 0;
+        bottom: 0;
+        left: 0;
+    }
+    .inserted {
+      position:absolute;
+      z-index:20;
+      background-color: #FFC107;
+    }
+    .deleted {
+      position:absolute;
+      z-index:20;
+      background-color: #FFC107;
+    }
+    </style>
+  </head>
+  <body>
+
+    <div id="ace"></div>
+    <script src="../bower_components/yjs/y.es6"></script>
+    <script src="../bower_components/ace-builds/src/ace.js"></script>
+    
+    <script src="./index.js"></script>
+  </body>
+</html>
--- a/Examples/Ace/index.js
+++ b/Examples/Ace/index.js
@@ -0,0 +1,25 @@
+/* global Y, ace */
+
+// initialize a shared object. This function call returns a promise!
+Y({
+  db: {
+    name: 'memory'
+  },
+  connector: {
+    name: 'websockets-client',
+    room: 'ace-example'
+  },
+  sourceDir: '/bower_components',
+  share: {
+    ace: 'Text' // y.share.textarea is of type Y.Text
+  }
+}).then(function (y) {
+  window.yAce = y
+
+  // bind the textarea to a shared text element
+  var editor = ace.edit('ace')
+  editor.setTheme('ace/theme/chrome')
+  editor.getSession().setMode('ace/mode/javascript')
+
+  y.share.ace.bindAce(editor)
+})
--- a/Examples/Chat/index.js
+++ b/Examples/Chat/index.js
@@ -9,15 +9,13 @@ Y({
  connector: {
    name: 'websockets-client',
    room: 'chat-example'
-    // debug: true,
-    // url: 'http://127.0.0.1:2345'
  },
  sourceDir: '/bower_components',
  share: {
    chat: 'Array'
  }
 }).then(function (y) {
-  window.y = y
+  window.yChat = y
  // This functions inserts a message at the specified position in the DOM
  function appendMessage(message, position) { 
    var p = document.createElement('p')
@@ -40,12 +38,14 @@ Y({
  cleanupChat()
  
  // whenever content changes, make sure to reflect the changes in the DOM
-  y.share.chat.observe(function (events) {
-    for (var i = 0; i < events.length; i++) {
-      if (events[i].type === 'insert') {
-        appendMessage(events[i].value, events[i].index)
-      } else if (events[i].type === 'delete') {
-        chat.children[events[i].index].remove()
+  y.share.chat.observe(function (event) {
+    if (event.type === 'insert') {
+      for (var i = 0; i < event.length; i++) {
+        appendMessage(event.values[i], event.index + i)
+      }
+    } else if (event.type === 'delete') {
+      for (var i = 0; i < event.length; i++) {
+        chat.children[event.index].remove()
      }
    }
    // concurrent insertions may result in a history > 7, so cleanup here
@@ -66,7 +66,7 @@ Y({
      // This will call the observe function (see line 40)
      // and reflect the change in the DOM
      y.share.chat.push([message])
-      this.reset()
+      this.querySelector("[name=message]").value = ""
    }
    // Do not send this form!
    event.preventDefault()
--- a/Examples/Drawing/index.html
+++ b/Examples/Drawing/index.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<body>
+  <style>
+    path {
+      fill: none;
+      stroke: blue;
+      stroke-width: 1px;
+      stroke-linejoin: round;
+      stroke-linecap: round;
+    }
+  </style>
+  <button type="button" id="clearDrawingCanvas">Clear Drawing</button>
+  <svg id="drawingCanvas" viewbox="0 0 100 100" width="100%"></svg>
+  <script src="../bower_components/yjs/y.js"></script>
+  <script src="../bower_components/d3/d3.js"></script>
+  <script src="./index.js"></script>
+</body>
+</html>
--- a/Examples/Drawing/index.js
+++ b/Examples/Drawing/index.js
@@ -0,0 +1,84 @@
+/* globals Y, d3 */
+'strict mode'
+
+Y({
+  db: {
+    name: 'memory'
+  },
+  connector: {
+    name: 'websockets-client',
+    room: 'drawing-example'
+    // url: 'localhost:1234'
+  },
+  sourceDir: '/bower_components',
+  share: {
+    drawing: 'Array'
+  }
+}).then(function (y) {
+  window.yDrawing = y
+  var drawing = y.share.drawing
+  var renderPath = d3.svg.line()
+    .x(function (d) { return d[0] })
+    .y(function (d) { return d[1] })
+    .interpolate('basis')
+
+  var svg = d3.select('#drawingCanvas')
+    .call(d3.behavior.drag()
+      .on('dragstart', dragstart)
+      .on('drag', drag)
+      .on('dragend', dragend))
+
+  // create line from a shared array object and update the line when the array changes
+  function drawLine (yarray) {
+    var line = svg.append('path').datum(yarray.toArray())
+    line.attr('d', renderPath)
+    yarray.observe(function (event) {
+      // we only implement insert events that are appended to the end of the array
+      event.values.forEach(function (value) {
+        line.datum().push(value)
+      })
+      line.attr('d', renderPath)
+    })
+  }
+  // call drawLine every time an array is appended
+  y.share.drawing.observe(function (event) {
+    if (event.type === 'insert') {
+      event.values.forEach(drawLine)
+    } else {
+      // just remove all elements (thats what we do anyway)
+      svg.selectAll('path').remove()
+    }
+  })
+  // draw all existing content
+  for (var i = 0; i < drawing.length; i++) {
+    drawLine(drawing.get(i))
+  }
+
+  // clear canvas on request
+  document.querySelector('#clearDrawingCanvas').onclick = function () {
+    drawing.delete(0, drawing.length)
+  }
+
+  var sharedLine = null
+  function dragstart () {
+    drawing.insert(drawing.length, [Y.Array])
+    sharedLine = drawing.get(drawing.length - 1)
+  }
+
+  // After one dragged event is recognized, we ignore them for 33ms.
+  var ignoreDrag = null
+  function drag () {
+    if (sharedLine != null && ignoreDrag == null) {
+      ignoreDrag = window.setTimeout(function () {
+        ignoreDrag = null
+      }, 33)
+      sharedLine.push([d3.mouse(this)])
+    }
+  }
+
+  function dragend () {
+    sharedLine = null
+    window.clearTimeout(ignoreDrag)
+    ignoreDrag = null
+  }
+})
--- a/Examples/Jigsaw/index.js
+++ b/Examples/Jigsaw/index.js
@@ -8,9 +8,7 @@ Y({
  },
  connector: {
    name: 'websockets-client',
-    room: 'Puzzle-example2'
-    // debug: true,
-    // url: 'http://127.0.0.1:2345'
+    room: 'Puzzle-example'
  },
  sourceDir: '/bower_components',
  share: {
@@ -20,6 +18,7 @@ Y({
    piece4: 'Map'
  }
 }).then(function (y) {
+  window.yJigsaw = y
  var origin // mouse start position - translation of piece  
  var drag = d3.behavior.drag()
    .on('dragstart', function (params) {
--- a/Examples/Quill/index.html
+++ b/Examples/Quill/index.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <!-- quill does not include dist files! We are using the hosted version instead -->
+  <!--link rel="stylesheet" href="../bower_components/quill/dist/quill.snow.css" /-->
+  <link href="https://cdn.quilljs.com/1.0.4/quill.snow.css" rel="stylesheet">
+  <link href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css" rel="stylesheet"> 
+  <link href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/monokai-sublime.min.css" rel="stylesheet">
+  <style>
+    #quill-container {
+      border: 1px solid gray;
+      box-shadow: 0px 0px 10px gray;
+    }
+  </style>
+</head>
+<body>
+  <div id="quill-container">
+    <div id="quill">
+    </div>
+  </div>
+
+  <script src="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.js" type="text/javascript"></script>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/highlight.min.js" type="text/javascript"></script>
+  <script src="https://cdn.quilljs.com/1.0.4/quill.js"></script>
+  <!-- quill does not include dist files! We are using the hosted version instead (see above)
+  <script src="../bower_components/quill/dist/quill.js"></script>
+  -->
+  <script src="../bower_components/yjs/y.es6"></script>
+  <script src="./index.js"></script>
+</body>
+</html>
--- a/Examples/Quill/index.js
+++ b/Examples/Quill/index.js
@@ -0,0 +1,40 @@
+/* global Y, Quill */
+
+// initialize a shared object. This function call returns a promise!
+
+Y({
+  db: {
+    name: 'memory'
+  },
+  connector: {
+    name: 'websockets-client',
+    room: 'richtext-example-quill-1.0-test'
+  },
+  sourceDir: '/bower_components',
+  share: {
+    richtext: 'Richtext' // y.share.richtext is of type Y.Richtext
+  }
+}).then(function (y) {
+  window.yQuill = y
+
+  // create quill element
+  window.quill = new Quill('#quill', {
+    modules: {
+      formula: true,
+      syntax: true,
+      toolbar: [
+        [{ size: ['small', false, 'large', 'huge'] }],
+        ['bold', 'italic', 'underline'],
+        [{ color: [] }, { background: [] }],    // Snow theme fills in values
+        [{ script: 'sub' }, { script: 'super' }],
+        ['link', 'image'],
+        ['link', 'code-block'],
+        [{list: 'ordered' }]
+      ]
+    },
+    theme: 'snow'
+  });
+  // bind quill to richtext type
+  y.share.richtext.bind(window.quill)
+})
+
--- a/Examples/Textarea/index.html
+++ b/Examples/Textarea/index.html
@@ -2,7 +2,7 @@
 <html>
 <body>
  <textarea style="width:80%;" rows=40 id="textfield" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"></textarea>
-  <script src="../bower_components/yjs/y.js"></script>
+  <script src="../bower_components/yjs/y.es6"></script>
  <script src="./index.js"></script>
 </body>
 </html>
--- a/Examples/Textarea/index.js
+++ b/Examples/Textarea/index.js
@@ -8,15 +8,13 @@ Y({
  connector: {
    name: 'websockets-client',
    room: 'Textarea-example'
-    // debug: true
-    // url: 'http://127.0.0.1:2345'
  },
  sourceDir: '/bower_components',
  share: {
    textarea: 'Text' // y.share.textarea is of type Y.Text
  }
 }).then(function (y) {
-  window.y = y
+  window.yTextarea = y

  // bind the textarea to a shared text element
  y.share.textarea.bind(document.getElementById('textfield'))
--- a/Examples/Xml/index.html
+++ b/Examples/Xml/index.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+</head>
+  <script src="../bower_components/yjs/y.es6"></script>
+  <script src="../bower_components/jquery/dist/jquery.min.js"></script>
+  <script src="./index.js"></script>
+</head>
+<body>
+  <h1> Shared DOM Example </h1>
+  <p> Use native DOM function or jQuery to manipulate the shared DOM (window.sharedDom). </p>
+  <div class="command">
+    <button type="button">Execute</button>
+    <input type="text" value='$(sharedDom).append("<h3>Appended headline</h3>")' size="40"/>
+  </div>
+  <div class="command">
+    <button type="button">Execute</button>
+    <input type="text" value='$(sharedDom).attr("align","right")' size="40"/>
+  </div>
+  <div class="command">
+    <button type="button">Execute</button>
+    <input type="text" value='$(sharedDom).attr("style","color:blue;")' size="40"/>
+  </div>
+  
+  <script>
+    var commands = document.querySelectorAll(".command");
+    Array.prototype.forEach.call(document.querySelectorAll('.command'), function (command) {
+      var execute = function(){
+        eval(command.querySelector("input").value);
+      }
+      command.querySelector("button").onclick = execute
+      $(command.querySelector("input")).keyup(function (e) {
+        if (e.keyCode == 13) {
+          execute()
+        }
+      })
+    })
+  </script>
+</body>
+</html>
--- a/Examples/Xml/index.js
+++ b/Examples/Xml/index.js
@@ -0,0 +1,21 @@
+/* global Y */
+
+// initialize a shared object. This function call returns a promise!
+Y({
+  db: {
+    name: 'memory'
+  },
+  connector: {
+    name: 'websockets-client',
+    room: 'Xml-example'
+  },
+  sourceDir: '/bower_components',
+  share: {
+    xml: 'Xml("p")' // y.share.xml is of type Y.Xml with tagname "p"
+  }
+}).then(function (y) {
+  window.yXml = y
+  // bind xml type to a dom, and put it in body
+  window.sharedDom = y.share.xml.getDom()
+  document.body.appendChild(window.sharedDom)
+})
--- a/Examples/bower.json
+++ b/Examples/bower.json
@@ -9,6 +9,20 @@
  "license": "MIT",
  "ignore": [],
  "dependencies": {
-    "yjs": "../"
+    "yjs": "latest",
+    "y-array": "latest",
+    "y-map": "latest",
+    "y-memory": "latest",
+    "y-richtext": "latest",
+    "y-webrtc": "latest",
+    "y-websockets-client": "latest",
+    "y-text": "latest",
+    "y-indexeddb": "latest",
+    "y-xml": "latest",
+    "quill": "^1.0.0-rc.2",
+    "ace": "~1.2.3",
+    "ace-builds": "~1.2.3",
+    "jquery": "~2.2.2",
+    "d3": "^3.5.16"
  }
 }
--- a/README.md
+++ b/README.md
@@ -1,128 +1,232 @@

 # ![Yjs](http://y-js.org/images/yjs.png)

-Yjs is a framework for optimistic concurrency control and automatic conflict resolution on shared data types. The framework implements a new OT-like concurrency algorithm and provides similar functionality as [ShareJs] and [OpenCoweb]. Yjs was designed to handle concurrent actions on arbitrary complex data types like Text, Json, and XML. We provide a tutorial and some applications for this framework on our [homepage](http://y-js.org/).
+Yjs is a framework for p2p shared editing on structured data like (rich-)text, json, and XML.
+It is similar to [ShareJs] and [OpenCoweb], but easy to use.
+For additional information, demos, and tutorials visit [y-js.org](http://y-js.org/).

-**NOTE** This project is currently migrating. So there may exist some information that is not true anymore..
+### Extensions
+Yjs only knows how to resolve conflicts on shared data. You have to choose a ..
+* *Connector* - a communication protocol that propagates changes to the clients 
+* *Database* - a database to store your changes
+* one or more *Types* - that represent the shared data

-You can create you own shared types easily. Therefore, you can take matters into your own hand by defining the meaning of the shared types and ensure that it is valid, while Yjs ensures data consistency (everyone will eventually end up with the same data). We already provide data types for
+Connectors, Databases, and Types are available as modules that extend Yjs. Here is a list of the modules we know of:

-| Name     | Description       |
-|----------|-------------------|
-|[map](https://github.com/y-js/y-map) | Add, update, and remove properties of an object. Included in Yjs|
-|[array](https://github.com/y-js/y-array) | A shared linked list implementation |
-|[selections](https://github.com/y-js/y-selections) | Manages selections on types that use linear structures (e.g. the y-array type). Select a range of elements, and assign meaning to them.|
-|[xml](https://github.com/y-js/y-xml) | An implementation of the DOM. You can create a two way binding to Browser DOM objects|
-|[text](https://github.com/y-js/y-text) | Collaborate on text. Supports two way binding to textareas, input elements, or HTML elements (e.g. *h1*, or *p*)|
-|[richtext](https://github.com/y-js/y-richtext) | Collaborate on rich text. Supports two way binding to several editors|
-
-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.
-
-We support several communication protocols as so called *Connectors*. You can create your own connector too - read [this wiki page](https://github.com/y-js/yjs/wiki/Custom-Connectors). Currently, we support the following communication protocols:
+##### Connectors

 |Name            | Description               |
 |----------------|-----------------------------------|
-|[xmpp](https://github.com/y-js/y-xmpp) | Propagate updates in a XMPP multi-user-chat room ([XEP-0045](http://xmpp.org/extensions/xep-0045.html))|
 |[webrtc](https://github.com/y-js/y-webrtc) | Propagate updates Browser2Browser via WebRTC|
+|[websockets](https://github.com/y-js/y-websockets-client) | Set up [a central server](https://github.com/y-js/y-websockets-client), and connect to it via websockets |
+|[xmpp](https://github.com/y-js/y-xmpp) | Propagate updates in a XMPP multi-user-chat room ([XEP-0045](http://xmpp.org/extensions/xep-0045.html))|
 |[test](https://github.com/y-js/y-test) | A Connector for testing purposes. It is designed to simulate delays that happen in worst case scenarios|

+##### Database adapters

-You can use Yjs client-, and server- side. You can get it as via npm, and bower. We even provide polymer elements for Yjs!
+|Name            | Description               |
+|----------------|-----------------------------------|
+|[memory](https://github.com/y-js/y-memory) | In-memory storage. |
+|[indexeddb](https://github.com/y-js/y-indexeddb) | Offline storage for the browser |
+|[leveldb](https://github.com/y-js/y-leveldb) | Persistent storage for node apps |

-The advantages over similar frameworks are support for
-* .. P2P message propagation and arbitrary communication protocols
-* .. arbitrary complex data types
-* .. offline editing: Changes are stored persistently and only relevant changes are propagated on rejoin
-* .. AnyUndo: Undo *any* action that was executed in constant time (coming..)
-* .. Intention Preservation: When working on Text, the intention of your changes are preserved. This is particularily important when working offline. Every type has a notion on how we define Intention Preservation on it.

-## Use it!
-You can find a tutorial, and examples on the [website](http://y-js.org). Furthermore, the [github wiki](https://github.com/y-js/yjs/wiki) offers more information about how you can use Yjs in your application.
+##### Types

-Either clone this git repository, install it with [bower](http://bower.io/), or install it with [npm](https://www.npmjs.org/package/yjs).
+| Name     | Description       |
+|----------|-------------------|
+|[map](https://github.com/y-js/y-map) | A shared Map implementation. Maps from text to any stringify-able object |
+|[array](https://github.com/y-js/y-array) | A shared Array implementation |
+|[xml](https://github.com/y-js/y-xml) | An implementation of the DOM. You can create a two way binding to Browser DOM objects |
+|[text](https://github.com/y-js/y-text) | Collaborate on text. Supports two way binding to the [Ace Editor](https://ace.c9.io), textareas, input elements, and HTML elements (e.g. <*h1*>, or <*p*>) |
+|[richtext](https://github.com/y-js/y-richtext) | Collaborate on rich text. Supports two way binding to the [Quill Rich Text Editor](http://quilljs.com/)|
+
+## Use it! 
+Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).  

 ### Bower
 ```
-bower install y-js/yjs
+bower install --save yjs y-array % add all y-* modules you want to use
 ```
-Then you include the libraries directly from the installation folder.
+You only need to include the `y.js` file. Yjs is able to automatically require missing modules.  
 ```
 <script src="./bower_components/yjs/y.js"></script>
 ```

 ### Npm
 ```
-npm install yjs --save
+npm install --save yjs % add all y-* modules you want to use
 ```

-And use it like this with *npm*:
+If you don't include via script tag, you have to explicitly include all modules! (Same goes for other module systems)
 ```
-Y = require("yjs");
+var Y = require('yjs')
+require('y-array')(Y) // add the y-array type to Yjs
+require('y-websockets-client')(Y)
+require('y-memory')(Y)
+require('y-array')(Y)
+require('y-map')(Y)
+require('y-text')(Y)
+// ..
+// do the same for all modules you want to use
 ```

-# Y()
-In order to create an instance of Y, you need to have a connection object (instance of a Connector). Then, you can create a shared data type like this:
+# Text editing example
+Install dependencies
 ```
-var y = new Y(connector);
+bower i yjs y-memory y-webrtc y-array y-text
 ```

-
-# Y.Map
-Yjs includes only one type by default - the Y.Map type. It mimics the behaviour of a javascript Object. You can create, update, and remove properies on the Y.Map type. Furthermore, you can observe changes on this type as you can observe changes on Javascript Objects with [Object.observe](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/observe) - an ECMAScript 7 proposal which is likely to become accepted by the committee. Until then, we have our own implementation.
-
-
-##### Reference
-* Create
+Here is a simple example of a shared textarea
 ```
-var map = y.set("new_map", Y.Map).then(function(map){
-  map // is my map type
-});
+  <!DOCTYPE html>
+  <html>
+    <body>
+      <script src="./bower_components/yjs/y.js"></script>
+      <script>
+        Y({
+          db: {
+            name: 'memory' // use memory database adapter.
+            // name: 'indexeddb'
+            // name: 'leveldb'
+          },
+          connector: {
+            name: 'webrtc', // use webrtc connector
+            // name: 'websockets-client'
+            // name: 'xmpp'
+            room: 'my-room' // clients connecting to the same room share data 
+          },
+          sourceDir: '/bower_components', // location of the y-* modules (browser only)
+          share: {
+            textarea: 'Text' // y.share.textarea is of type y-text
+          }
+        }).then(function (y) {
+          // The Yjs instance `y` is available
+          // y.share.* contains the shared types
+  
+          // Bind the textarea to y.share.textarea
+          y.share.textarea.bind(document.querySelector('textarea'))
+        }
+      </script>
+      <textarea></textarea>
+    </body>
+  </html>
 ```
-* Every instance of Y is an Y.Map
+
+## Get Help & Give Help
+There are some friendly people on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/y-js/yjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) who are eager to help, and answer questions. Please join!
+
+Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issues)! I try to fix them very soon, if possible.
+
+# API
+
+### Y(options)
+* options.db
+  * Will be forwarded to the database adapter. Specify the database adaper on `options.db.name`.
+  * Have a look at the used database adapter repository to see all available options.
+* options.connector
+  * Will be forwarded to the connector adapter. Specify the connector adaper on `options.connector.name`.
+  * All our connectors implement a `room` property. Clients that specify the same room share the same data.
+  * All of our connectors specify an `url` property that defines the connection endpoint of the used connector.
+    * All of our connectors also have a default connection endpoint that you can use for development. 
+  * Have a look at the used connector repository to see all available options.
+* options.sourceDir (browser only)
+  * Path where all y-* modules are stored
+  * Defaults to `/bower_components`
+  * Not required when running on `nodejs` / `iojs`
+  * When using nodejs you need to manually extend Yjs:
 ```
-var y = new Y(options);
-```
-* .get(name)
-  * Retrieve the value of a property. If the value is a type, `.get(name)` returns a promise
-* .set(name, value)
-  * Set/update a property. `value` may be a primitive type, or a custom type definition (e.g. `Y.Map`)
-* .delete(name)
-  * Delete a property
-* .observe(observer)
-  * The `observer` is called whenever something on this object changes. Throws *add*, *update*, and *delete* events
-* .observePath(path, observer)
-  * `path` is an array of property names. `observer` is called when the property under `path` is set, deleted, or updated
-* .unobserve(f)
-  * Delete an observer
+var Y = require('yjs')
+// you have to require a db, connector, and *all* types you use! 
+require('y-memory')(Y)
+require('y-webrtc')(Y)
+require('y-map')(Y)
+// ..
+``` 
+* options.share
+  * Specify on `options.share[arbitraryName]` types that are shared among all users.
+  * E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and create an y-array type on `y.share[arbitraryName]`.
+  * If userA doesn't specify `options.share[arbitraryName]`, it won't be available for userA.
+  * If userB specifies `options.share[arbitraryName]`, it still won't be available for userA. But all the updates are send from userB to userA.
+  * In contrast to y-map, types on `y.share.*` cannot be overwritten or deleted. Instead, they are merged among all users. This feature is only available on `y.share.*`
+  * Weird behavior: It is supported that two users specify different types with the same property name.
+     E.g. userA specifies `options.share.x = 'Array'`, and userB specifies `options.share.x = 'Text'`. But they only share data if they specified the same type with the same property name
+* options.type (browser only)
+  * Array of modules that Yjs needs to require, before instantiating a shared type.
+  * By default Yjs requires the specified database adapter, the specified connector, and all modules that are used in `options.share.*`
+  * Put all types here that you intend to use, but are not used in y.share.*

-# A note on intention preservation
-When users create/update/delete the same property concurrently, only one change will prevail. Changes on different properties do not conflict with each other.
+### Instantiated Y object (y)
+`Y(options)` returns a promise that is fulfilled when..

-# A note on time complexities
-* .get(name)
-  * O(1)
-* .set(name, value)
-  * O(1)
-* .delete(name)
-  * O(1)
-* Apply a delete operation from another user
-  * O(1)
-* Apply an update operation from another user (set/update a property)
-  * Yjs does not transform against operations that do not conflict with each other.
-  * An operation conflicts with another operation if it changes the same property.
-  * Overall worst case complexety: O(|conflicts|!)
+* All modules are loaded
+  * The specified database adapter is loaded
+  * The specified connector is loaded
+  * All types are included
+* The connector is initialized, and a unique user id is set (received from the server)
+  * Note: When using y-indexeddb, a retrieved user id is stored on `localStorage`

-# Status
-Yjs is a work in progress. Different versions of the *y-* repositories may not work together. Just drop me a line if you run into troubles.
+The promise returns an instance of Y. We denote it with a lower case `y`.

-## Get help
-There are some friendly people on [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/y-js/yjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) who may help you with your problem, and answer your questions.
-
-Please report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issues)! I try to fix them very soon, if possible.
+* y.share.*
+  * Instances of the types you specified on options.share.*
+  * y.share.* can only be defined once when you instantiate Y!
+* y.connector is an instance of Y.AbstractConnector
+* y.connector.onUserEvent(function (event) {..})
+  * Observe user events (event.action is either 'userLeft' or 'userJoined')
+* y.connector.whenSynced(listener)
+  * `listener` is executed when y synced with at least one user.
+  * `listener` is not called when no other user is in the same room.
+  * y-websockets-client aways waits to sync with the server
+* y.connector.disconnect()
+  * Force to disconnect this instance from the other instances
+* y.connector.reconnect()
+  * Try to reconnect to the other instances (needs to be supported by the connector)
+  * Not supported by y-xmpp 
+* y.destroy()
+  * Destroy this object.
+  * Destroys all types (they will throw weird errors if you still use them)
+  * Disconnects from the other instances (via connector)
+  * Removes all data from the database
+* y.db.stopGarbageCollector()
+  * Stop the garbage collector. Call y.db.garbageCollect() to continue garbage collection
+* y.db.gcTimeout :: Number (defaults to 50000 ms)
+  * Time interval between two garbage collect cycles
+  * It is required that all instances exchanged all messages after two garbage collect cycles (after 100000 ms per default)
+* y.db.userId :: String
+  * The used user id for this client. **Never overwrite this**

 ## Changelog
-### 1.0.0
-This is a complete rewrite of the 0.5 version of Yjs. Since Yjs 1.0 it is possible to work asynchronously on a persistent database, which enables offline support.
+
+### 12.0.0
+* **Types are synchronous and never return a promise (except explicitly stated)**
+  * `y.share.map.get('map type') // => returns a y-map instead of a promise`
+  * The event property `oldValues`, and `values` contain a list of values (without wrapper)
+* Support for the [y-leveldb](https://github.com/y-js/y-leveldb) database adapter
+* [y-richtext](https://github.com/y-js/y-richtext) supports Quill@1.0.0-rc.2
+* Only the types are affected by this release. You have to upgrade y-array@10.0.0, y-map@10.0.0, y-richtext@9.0.0, and y-xml@10.0.0
+
+### 11.0.0
+
+* **All types return a single event instead of list of events**
+  * Insert events contain a list of values
+* Improved performance for large insertions & deletions
+* Several bugfixes (offline editing related)
+* Native support for node 4 (see #49)
+
+### 10.0.0
+
+* Support for more complex types (a type can be a composition of several types)
+* Fixes several memory leaks
+
+### 9.0.0
+There were several rolling updates from 0.6 to 0.8. We consider Yjs stable since a long time, 
+and intend to continue stable releases. From this release forward y-* modules will implement peer-dependencies for npm, and dependencies for bower.
+Furthermore, incompatible yjs instances throw errors now when syncing - this feature was influenced by #48. The versioning jump was influenced by react (see [here](https://facebook.github.io/react/blog/2016/02/19/new-versioning-scheme.html))
+
+
+### 0.6.0
+This is a complete rewrite of the 0.5 version of Yjs. Since Yjs 0.6.0 it is possible to work asynchronously on a persistent database, which enables offline support.
 * Switched to semver versioning
 * Requires a promise implementation in environment (es6 promises suffice, included in all the major browsers). Otherwise you have to include a polyfill
 * Y.Object has been renamed to Y.Map
@@ -144,3 +248,4 @@ Yjs is licensed under the [MIT License](./LICENSE.txt).

 [ShareJs]: https://github.com/share/ShareJS
 [OpenCoweb]: https://github.com/opencoweb/coweb/wiki
+
--- a/bower.json
+++ b/bower.json
@@ -1,19 +1,21 @@
 {
  "name": "yjs",
-  "version": "0.7.1",
+  "version": "12.0.1",
  "homepage": "y-js.org",
  "authors": [
    "Kevin Jahns <kevin.jahns@rwth-aachen.de>"
  ],
-  "description": "A Framework that enables Real-Time collaboration on arbitrary data structures.",
-  "main": "y.js",
+  "description": "A Framework for shared editing on any data",
+  "main": "./y.js",
  "keywords": [
+    "Yjs",
    "OT",
-    "collaboration",
-    "synchronization",
-    "sharejs",
-    "coweb",
-    "concurrency"
+    "Collaboration",
+    "Synchronization",
+    "ShareJS",
+    "Coweb",
+    "Concurrency"
  ],
-  "license": "MIT"
+  "license": "MIT",
+  "ignore": []
 }
--- a/package.json
+++ b/package.json
@@ -1,76 +0,0 @@
-{
-  "name": "yjs",
-  "version": "0.7.1",
-  "description": "A framework for real-time p2p shared editing on arbitrary complex data types",
-  "main": "y.js",
-  "scripts": {
-    "test": "node --harmony ./node_modules/.bin/gulp test",
-    "lint": "./node_modules/.bin/standard"
-  },
-  "pre-commit": [
-    "lint",
-    "test"
-  ],
-  "standard": {
-    "parser": "babel-eslint",
-    "ignore": [
-      "build/**",
-      "dist/**",
-      "declarations/**",
-      "./y.js",
-      "./y.js.map"
-    ]
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/y-js/yjs.git"
-  },
-  "keywords": [
-    "OT",
-    "Operational Transformation",
-    "collaboration",
-    "synchronization",
-    "ShareJs",
-    "OpenCoweb",
-    "concurrency"
-  ],
-  "author": "Kevin Jahns",
-  "email": "kevin.jahns@rwth-aachen.de",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/y-js/yjs/issues"
-  },
-  "homepage": "http://y-js.org",
-  "devDependencies": {
-    "babel-plugin-transform-runtime": "^6.1.18",
-    "babel-preset-es2015": "^6.1.18",
-    "babelify": "^7.2.0",
-    "browserify": "^12.0.1",
-    "eslint": "^1.10.2",
-    "gulp": "^3.9.0",
-    "gulp-bump": "^1.0.0",
-    "gulp-concat": "^2.6.0",
-    "gulp-filter": "^3.0.1",
-    "gulp-git": "^1.6.0",
-    "gulp-if": "^2.0.0",
-    "gulp-jasmine": "^2.0.1",
-    "gulp-jasmine-browser": "^0.2.3",
-    "gulp-load-plugins": "^1.0.0",
-    "gulp-prompt": "^0.1.2",
-    "gulp-rename": "^1.2.2",
-    "gulp-serve": "^1.2.0",
-    "gulp-shell": "^0.5.1",
-    "gulp-sourcemaps": "^1.5.2",
-    "gulp-tag-version": "^1.3.0",
-    "gulp-uglify": "^1.5.1",
-    "gulp-util": "^3.0.6",
-    "gulp-watch": "^4.3.5",
-    "minimist": "^1.2.0",
-    "pre-commit": "^1.1.1",
-    "regenerator": "^0.8.42",
-    "run-sequence": "^1.1.4",
-    "standard": "^5.2.2",
-    "vinyl-buffer": "^1.0.0",
-    "vinyl-source-stream": "^1.1.0"
-  }
-}
--- a/y.es6
+++ b/y.es6
--- a/y.es6.map
+++ b/y.es6.map
--- a/y.js
+++ b/y.js
--- a/y.js.map
+++ b/y.js.map
Author	SHA1	Message	Date
Kevin Jahns	723fc77627	Deploy 12.0.1	2016-09-27 16:17:27 +02:00
Kevin Jahns	9eac8d9398	Deploy 12.0.0	2016-09-20 19:19:14 +02:00
Kevin Jahns	0b14e90585	update examples	2016-09-20 18:29:19 +02:00
Kevin Jahns	4726c71dd0	update quill example	2016-08-29 17:47:38 +02:00
Kevin Jahns	59d859b38b	updated quill example	2016-08-22 12:57:04 +02:00
Kevin Jahns	81c8504462	Deploy 11.2.5	2016-08-22 12:15:16 +02:00
Kevin Jahns	c926ce09f5	Deploy 11.2.4	2016-08-04 19:25:20 +02:00
Kevin Jahns	653a436b88	Deploy 11.2.2	2016-08-01 17:03:26 +02:00
Kevin Jahns	5ab60028ce	update y-richtext example	2016-07-05 16:20:36 +02:00
Kevin Jahns	428d825f41	Deploy 11.2.1	2016-05-24 15:24:53 +02:00
Kevin Jahns	b9f9c762eb	Deploy 11.2.0	2016-05-10 18:12:57 +02:00
Kevin Jahns	80ab682b0a	Deploy 11.1.0	2016-05-07 13:20:37 +01:00
Kevin Jahns	3f60690880	Deploy 11.0.4	2016-05-02 10:59:58 +02:00
Kevin Jahns	e2f93af86e	added drawing example	2016-04-30 23:00:23 +01:00
Kevin Jahns	76ebd3043d	Deploy 11.0.3	2016-04-27 12:04:30 +01:00
Kevin Jahns	b958b72f1d	Deploy 11.0.2	2016-04-26 21:28:18 +02:00
Kevin Jahns	89a920df68	Deploy 11.0.1	2016-04-26 15:34:16 +02:00
Kevin Jahns	c2b8d7b164	Deploy 11.0.0	2016-04-26 15:02:41 +02:00
Kevin Jahns	5c7bab422f	updated examples to new version	2016-04-26 14:39:49 +02:00
Kevin Jahns	f21e1c549a	Deploy 10.0.3	2016-03-23 19:55:48 +01:00
Kevin Jahns	3156c7b19f	updated xml example with commands	2016-03-23 19:53:52 +01:00
Kevin Jahns	658081566b	Deploy 10.0.2	2016-03-23 14:42:23 +01:00
Kevin Jahns	ffe0ec5a38	Deploy 10.0.1	2016-03-23 14:41:04 +01:00
Kevin Jahns	5cfe209688	added xml example	2016-03-14 19:45:50 +01:00
Kevin Jahns	51c8d3bdc6	Deploy 9.0.4	2016-02-24 12:00:45 +01:00
Kevin Jahns	0f86b71f78	add readme?	2016-02-24 12:00:02 +01:00
Kevin Jahns	fafda2726f	Deploy 9.0.3	2016-02-23 15:50:16 +01:00
Kevin Jahns	116770fbce	fix gitignore, fix Examples/bower.json	2016-02-23 15:47:53 +01:00
Kevin Jahns	5286f507c8	Deploy 9.0.2	2016-02-23 15:42:09 +01:00
Kevin Jahns	2f7349b712	fixed bower & added dependencies & cleanup	2016-02-23 15:41:22 +01:00
Kevin Jahns	54529ab1e7	Deploy 9.0.1	2016-02-23 11:58:10 +01:00
Kevin Jahns	e165c5ee2a	added peer dependencies, upgraded version to major (new versioning scheme)	2016-02-23 11:57:27 +01:00
Kevin Jahns	7b3693aff3	Deploy 0.8.28	2016-02-23 11:27:26 +01:00
Kevin Jahns	f75f47646b	Deploy 0.8.27	2016-02-22 13:08:01 +01:00
Kevin Jahns	64044123e3	Deploy 0.8.26	2016-02-22 13:06:11 +01:00
Kevin Jahns	a286162ace	Deploy 0.8.25	2016-02-22 13:04:32 +01:00
Kevin Jahns	f739f3b5d7	Deploy 0.8.23	2016-02-22 12:40:21 +01:00
Kevin Jahns	f2052f95f8	Deploy 0.8.22	2016-02-22 12:38:21 +01:00
Kevin Jahns	81324dc7d4	Deploy 0.8.21	2016-02-18 16:57:27 +01:00
Kevin Jahns	6599cb20b4	Deploy 0.8.20	2016-02-16 16:08:50 +01:00
Kevin Jahns	74ed9e4107	Deploy 0.8.18	2016-02-15 15:22:51 +01:00
Kevin Jahns	ef6d63c19a	Deploy 0.8.17	2016-02-04 23:13:47 +01:00
Kevin Jahns	941dd36e74	Deploy 0.8.16	2016-02-04 23:12:49 +01:00
Kevin Jahns	e74c22f0a9	Deploy 0.8.15	2016-02-04 23:11:07 +01:00
Kevin Jahns	98085b2807	Deploy 0.8.14	2016-02-04 15:26:28 +01:00
Kevin Jahns	e48608a7d4	update ace example	2016-02-04 12:53:27 +01:00
Kevin Jahns	ddbe19d78e	Deploy 0.8.13	2016-02-04 12:47:05 +01:00
Kevin Jahns	f9a9edcc26	Deploy 0.8.12	2016-02-04 12:12:53 +01:00
Kevin Jahns	4340f028b5	cleanup	2016-02-04 12:05:47 +01:00
Kevin Jahns	6a4aabe69c	Deploy 0.8.11	2016-02-04 10:52:55 +01:00
Kevin Jahns	6904e6018d	added ace example	2016-02-03 11:37:10 +01:00
Kevin Jahns	5e295b80d7	Deploy 0.8.9	2016-01-18 16:45:40 +01:00
Kevin Jahns	e58f633115	Deploy 0.8.8	2016-01-18 15:40:31 +01:00
Kevin Jahns	65ea42481e	Deploy 0.8.7	2016-01-16 01:45:53 +01:00
Kevin Jahns	a220b06ad9	Deploy 0.8.6	2016-01-16 01:41:55 +01:00
Kevin Jahns	2650338b4b	Deploy 0.8.5	2016-01-15 18:09:41 +01:00
Kevin Jahns	919dfb5e16	Deploy 0.8.4	2016-01-15 17:58:01 +01:00
Kevin Jahns	3b8e148d8f	Deploy 0.8.3	2016-01-15 03:46:51 +01:00
Kevin Jahns	a77eb39218	Deploy 0.8.2	2016-01-15 03:10:52 +01:00
Kevin Jahns	9902da470b	Deploy 0.8.1	2016-01-15 00:03:37 +01:00
Kevin Jahns	0ec83aa431	Deploy 0.8.0	2016-01-15 00:01:56 +01:00
Kevin Jahns	ff006c92d7	Deploy 0.7.6	2016-01-11 15:48:06 +01:00
Kevin Jahns	15a472df44	Deploy 0.7.5	2016-01-11 15:47:19 +01:00
Kevin Jahns	4cb0f2b5b9	publish v0.7.3	2016-01-09 21:07:04 +01:00
Kevin Jahns	ab6a193ec6	added safety to setUserId (when called twice)	2015-12-30 16:34:39 +01:00
Kevin Jahns	f18a6ee151	added quill example	2015-12-27 14:57:23 +01:00
Kevin Jahns	8ba1e4ce27	update	2015-12-18 16:34:00 +01:00