yonote/yjs
23
0
Fork 0
Code Pull Requests 1 Releases Activity

Deploy 12.1.5

Browse Source
This commit is contained in:
Kevin Jahns 2017-03-06 13:27:26 +01:00
parent c00dee819f
commit e1108d4007
8 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Examples/Ace/index.html
View File

@ -2,7 +2,7 @@
<html> <html>
<head> <head>
<style type="text/css" media="screen"> <style type="text/css" media="screen">
#ace { #aceContainer {
position: absolute; position: absolute;
top: 0; top: 0;
right: 0; right: 0;
@ -23,10 +23,10 @@
</head> </head>
<body> <body>
<div id="ace"></div> <div id="aceContainer"></div>
<script src="../bower_components/yjs/y.es6"></script> <script src="../bower_components/yjs/y.es6"></script>
<script src="../bower_components/ace-builds/src/ace.js"></script> <script src="../bower_components/ace-builds/src/ace.js"></script>
<script src="./index.js"></script> <script src="./index.js"></script>
</body> </body>
</html> </html>

2
Examples/Ace/index.js
View File

@ -17,7 +17,7 @@ Y({
window.yAce = y window.yAce = y
// bind the textarea to a shared text element // bind the textarea to a shared text element
var editor = ace.edit('ace') var editor = ace.edit('aceContainer')
editor.setTheme('ace/theme/chrome') editor.setTheme('ace/theme/chrome')
editor.getSession().setMode('ace/mode/javascript') editor.getSession().setMode('ace/mode/javascript')

20
README.md
View File

@ -7,7 +7,7 @@ For additional information, demos, and tutorials visit [y-js.org](http://y-js.or
### Extensions ### Extensions
Yjs only knows how to resolve conflicts on shared data. You have to choose a .. 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 * *Connector* - a communication protocol that propagates changes to the clients
* *Database* - a database to store your changes * *Database* - a database to store your changes
* one or more *Types* - that represent the shared data * one or more *Types* - that represent the shared data
@ -47,7 +47,7 @@ Connectors, Databases, and Types are available as modules that extend Yjs. Here
|-----------|-------------------| |-----------|-------------------|
|[y-element](http://y-js.org/y-element/) | Yjs Polymer Element | |[y-element](http://y-js.org/y-element/) | Yjs Polymer Element |
## Use it! ## Use it!
Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs). Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).
### Bower ### Bower
@ -113,7 +113,7 @@ Here is a simple example of a shared textarea
name: 'webrtc', // use webrtc connector name: 'webrtc', // use webrtc connector
// name: 'websockets-client' // name: 'websockets-client'
// name: 'xmpp' // name: 'xmpp'
room: 'my-room' // clients connecting to the same room share data room: 'my-room' // clients connecting to the same room share data
}, },
sourceDir: '/bower_components', // location of the y-* modules (browser only) sourceDir: '/bower_components', // location of the y-* modules (browser only)
share: { share: {
@ -122,7 +122,7 @@ Here is a simple example of a shared textarea
}).then(function (y) { }).then(function (y) {
// The Yjs instance `y` is available // The Yjs instance `y` is available
// y.share.* contains the shared types // y.share.* contains the shared types
// Bind `y.share.textarea` to `<textarea/>` // Bind `y.share.textarea` to `<textarea/>`
y.share.textarea.bind(document.querySelector('textarea')) y.share.textarea.bind(document.querySelector('textarea'))
}) })
@ -142,7 +142,7 @@ Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issue
### Y(options) ### Y(options)
* Y.extend(module1, module2, ..) * Y.extend(module1, module2, ..)
* Add extensions to Y * Add extensions to Y
* `Y.extend(require('y-webrtc'))` has the same semantics as `require('y-webrtc')(Y)` * `Y.extend(require('y-webrtc'))` has the same semantics as `require('y-webrtc')(Y)`
* options.db * options.db
* Will be forwarded to the database adapter. Specify the database adaper on `options.db.name`. * 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. * Have a look at the used database adapter repository to see all available options.
@ -150,7 +150,8 @@ Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issue
* Will be forwarded to the connector adapter. Specify the connector adaper on `options.connector.name`. * 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 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 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. * All of our connectors also have a default connection endpoint that you can use for development.
* 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 the server. Use with caution.
* Have a look at the used connector repository to see all available options. * Have a look at the used connector repository to see all available options.
* options.sourceDir (browser only) * options.sourceDir (browser only)
* Path where all y-* modules are stored * Path where all y-* modules are stored
@ -159,12 +160,12 @@ Report _any_ issues to the [Github issue page](https://github.com/y-js/yjs/issue
* When using nodejs you need to manually extend Yjs: * When using nodejs you need to manually extend Yjs:
``` ```
var Y = require('yjs') var Y = require('yjs')
// you have to require a db, connector, and *all* types you use! // you have to require a db, connector, and *all* types you use!
require('y-memory')(Y) require('y-memory')(Y)
require('y-webrtc')(Y) require('y-webrtc')(Y)
require('y-map')(Y) require('y-map')(Y)
// .. // ..
``` ```
* options.share * options.share
* Specify on `options.share[arbitraryName]` types that are shared among all users. * 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]`. * E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and create an y-array type on `y.share[arbitraryName]`.
@ -248,7 +249,7 @@ The promise returns an instance of Y. We denote it with a lower case `y`.
* Fixes several memory leaks * Fixes several memory leaks
### 9.0.0 ### 9.0.0
There were several rolling updates from 0.6 to 0.8. We consider Yjs stable since a long time, 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. 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)) 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))
@ -273,4 +274,3 @@ I created this framework during my bachelor thesis at the chair of computer scie
Yjs is licensed under the [MIT License](./LICENSE). Yjs is licensed under the [MIT License](./LICENSE).
<yjs@dbis.rwth-aachen.de> <yjs@dbis.rwth-aachen.de>

2
bower.json
View File

@ -1,6 +1,6 @@
{ {
"name": "yjs", "name": "yjs",
"version": "12.1.4", "version": "12.1.5",
"homepage": "y-js.org", "homepage": "y-js.org",
"authors": [ "authors": [
"Kevin Jahns <kevin.jahns@rwth-aachen.de>" "Kevin Jahns <kevin.jahns@rwth-aachen.de>"

10
y.es6
View File

@ -1,6 +1,6 @@
/** /**
* yjs - A framework for real-time p2p shared editing on any data * yjs - A framework for real-time p2p shared editing on any data
* @version v12.1.3 * @version v12.1.4
* @link http://y-js.org * @link http://y-js.org
* @license MIT * @license MIT
*/ */
@ -66,6 +66,9 @@ module.exports = function (Y/* :any */) {
this.protocolVersion = 11 this.protocolVersion = 11
this.authInfo = opts.auth || null this.authInfo = opts.auth || null
this.checkAuth = opts.checkAuth || function () { return Promise.resolve('write') } // default is everyone has write access this.checkAuth = opts.checkAuth || function () { return Promise.resolve('write') } // default is everyone has write access
if (opts.generateUserId === true) {
this.setUserId(Y.utils.generateGuid())
}
} }
resetAuth (auth) { resetAuth (auth) {
if (this.authInfo !== auth) { if (this.authInfo !== auth) {
@ -3471,6 +3474,11 @@ module.exports = function (Y /* : any*/) {
return SmallLookupBuffer return SmallLookupBuffer
} }
Y.utils.createSmallLookupBuffer = createSmallLookupBuffer Y.utils.createSmallLookupBuffer = createSmallLookupBuffer
// Generates a unique id, for use as a user id.
// Thx to @jed for this script https://gist.github.com/jed/982883
function generateGuid(a){return a?(a^Math.random()*16>>a/4).toString(16):([1e7]+-1e3+-4e3+-8e3+-1e11).replace(/[018]/g,generateGuid)} // eslint-disable-line
Y.utils.generateGuid = generateGuid
} }
},{}],7:[function(require,module,exports){ },{}],7:[function(require,module,exports){

2
y.es6.map
View File

File diff suppressed because one or more lines are too long

8
y.js
View File

File diff suppressed because one or more lines are too long

2
y.js.map
View File

File diff suppressed because one or more lines are too long