Release 12.3.3

README.md

@@ -55,23 +55,23 @@ Install Yjs, and its modules with [bower](http://bower.io/), or
 [npm](https://www.npmjs.org/package/yjs).
 
 ### Bower
-```
+```sh
 bower install --save yjs y-array % add all y-* modules you want to use
 ```
 You only need to include the `y.js` file. Yjs is able to automatically require
 missing modules.  
-```
+```html
 <script src="./bower_components/yjs/y.js"></script>
 ```
 
 ### Npm
-```
+```sh
 npm install --save yjs % add all y-* modules you want to use
 ```
 
 If you don't include via script tag, you have to explicitly include all modules!
 (Same goes for other module systems)
-```
+```js
 var Y = require('yjs')
 require('y-array')(Y) // add the y-array type to Yjs
 require('y-websockets-client')(Y)
@@ -84,7 +84,7 @@ require('y-text')(Y)
 ```
 
 ### ES6 Syntax
-```
+```js
 import Y from 'yjs'
 import yArray from 'y-array'
 import yWebsocketsClient from 'y-webrtc'
@@ -98,7 +98,7 @@ Y.extend(yArray, yWebsocketsClient, yMemory, yArray, yMap, yText /*, .. */)
 
 # Text editing example
 Install dependencies
-```
+```sh
 bower i yjs y-memory y-webrtc y-array y-text
 ```
 
@@ -166,6 +166,25 @@ soon, if possible.
     endpoint of the used connector.
     * All of our connectors also have a default connection endpoint that you can
       use for development.
+  * We provide basic authentification for all connectors. The value of
+    `options.connector.auth` (this can be a passphase) is sent to all connected
+    Yjs instances. `options.connector.checkAuth` may grant read or write access
+    depending on the `auth` information.
+    Example: A client specifies `options.connector.auth = 'superSecretPassword`.
+    A server specifies
+    ```js
+    options.connector.checkAuth = function (auth, yjsInstance, sender) {
+      return new Promise(function (resolve, reject){
+        if (auth === 'superSecretPassword') {
+          resolve('write') // grant read-write access
+        } else if (auth === 'different password') {
+          resolve('read') // grant read-only access
+        } else {
+          reject('wrong password!') // reject connection
+        }
+      })
+    }
+    ```
   * Set `options.connector.generateUserId = true` in order to genenerate a
     userid, instead of receiving one from the server. This way the `Y(..)` is
     immediately going to be resolved, without waiting for any confirmation from
@@ -181,7 +200,7 @@ soon, if possible.
   * Defaults to `/bower_components`
   * Not required when running on `nodejs` / `iojs`
   * When using nodejs you need to manually extend Yjs:
-```
+```js
 var Y = require('yjs')
 // you have to require a db, connector, and *all* types you use!
 require('y-memory')(Y)

dist

@@ -1 +1 @@
-Subproject commit 42aa7ec5c9c0b4f2734b5b01eae7f0df63bfd9ff
+Subproject commit 8739fd3a9c671c738fe0f31f1dc03193da776223

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yjs",
-  "version": "12.3.1",
+  "version": "12.3.3",
   "description": "A framework for real-time p2p shared editing on any data",
   "main": "./src/y.js",
   "scripts": {

src/Connector.js

@@ -1,6 +1,3 @@
-/* @flow */
-'use strict'
-
 function canRead (auth) { return auth === 'read' || auth === 'write' }
 function canWrite (auth) { return auth === 'write' }
 
@@ -39,7 +36,6 @@ module.exports = function (Y/* :any */) {
       // this client receives operations from only one other client.
       // In particular, this does not work with y-webrtc.
       // It will work with y-websockets-client
-      this.preferUntransformed = opts.preferUntransformed || false
       if (opts.role == null || opts.role === 'master') {
         this.role = 'master'
       } else if (opts.role === 'slave') {
@@ -191,9 +187,6 @@ module.exports = function (Y/* :any */) {
             protocolVersion: conn.protocolVersion,
             auth: conn.authInfo
           }
-          if (conn.preferUntransformed && Object.keys(stateSet).length === 0) {
-            answer.preferUntransformed = true
-          }
           conn.send(syncUser, answer)
         })
       } else {
@@ -272,7 +265,7 @@ module.exports = function (Y/* :any */) {
       }
       if (message.auth != null && this.connections[sender] != null) {
         // authenticate using auth in message
-        var auth = this.checkAuth(message.auth, this.y)
+        var auth = this.checkAuth(message.auth, this.y, sender)
         this.connections[sender].auth = auth
         auth.then(auth => {
           for (var f of this.userEventListeners) {
@@ -285,7 +278,7 @@ module.exports = function (Y/* :any */) {
         })
       } else if (this.connections[sender] != null && this.connections[sender].auth == null) {
         // authenticate without otherwise
-        this.connections[sender].auth = this.checkAuth(null, this.y)
+        this.connections[sender].auth = this.checkAuth(null, this.y, sender)
       }
       if (this.connections[sender] != null && this.connections[sender].auth != null) {
         return this.connections[sender].auth.then((auth) => {
@@ -307,11 +300,7 @@ module.exports = function (Y/* :any */) {
                 protocolVersion: this.protocolVersion,
                 auth: this.authInfo
               }
-              if (message.preferUntransformed === true && Object.keys(m.stateSet).length === 0) {
+              answer.os = yield* this.getOperations(m.stateSet)
-                answer.osUntransformed = yield* this.getOperationsUntransformed()
-              } else {
-                answer.os = yield* this.getOperations(m.stateSet)
-              }
               conn.send(sender, answer)
               if (this.forwardToSyncingClients) {
                 conn.syncingClients.push(sender)

src/Transaction.js

@@ -96,7 +96,7 @@ module.exports = function (Y/* :any */) {
           send.push(Y.Struct[op.struct].encode(op))
         }
       }
-      if (this.store.y.connector.isSynced && send.length > 0) { // TODO: && !this.store.forwardAppliedOperations (but then i don't send delete ops)
+      if (send.length > 0) { // TODO: && !this.store.forwardAppliedOperations (but then i don't send delete ops)
         // is connected, and this is not going to be send in addOperation
         this.store.y.connector.broadcastOps(send)
       }
@@ -717,7 +717,7 @@ module.exports = function (Y/* :any */) {
     }
     * addOperation (op) {
       yield* this.os.put(op)
-      if (this.store.y.connector.isSynced && this.store.forwardAppliedOperations && typeof op.id[1] !== 'string') {
+      if (this.store.forwardAppliedOperations && typeof op.id[1] !== 'string') {
         // is connected, and this is not going to be send in addOperation
         this.store.y.connector.broadcastOps([op])
       }