Compare commits
16 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
222ffea11e | ||
|
|
c3d21b5c8e | ||
|
|
3eafd78710 | ||
|
|
e30e16c91b | ||
|
|
20e3491a64 | ||
|
|
11b30c7072 | ||
|
|
d285e4258b | ||
|
|
54b0bf9e4c | ||
|
|
bbfb1d9bcb | ||
|
|
e1108d4007 | ||
|
|
c00dee819f | ||
|
|
92b9cb8143 | ||
|
|
5dad1ed410 | ||
|
|
b613630cef | ||
|
|
afa05b62a1 | ||
|
|
957d650f81 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +1,2 @@
|
|||||||
|
node_modules
|
||||||
bower_components
|
bower_components
|
||||||
|
|||||||
@@ -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>
|
||||||
|
|||||||
@@ -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')
|
||||||
|
|
||||||
|
|||||||
23
Examples/CodeMirror/index.html
Normal file
23
Examples/CodeMirror/index.html
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="codeMirrorContainer"></div>
|
||||||
|
|
||||||
|
<script src="../bower_components/yjs/y.es6"></script>
|
||||||
|
<script src="../bower_components/codemirror/lib/codemirror.js"></script>
|
||||||
|
<script src="../bower_components/codemirror/mode/javascript/javascript.js"></script>
|
||||||
|
<link rel="stylesheet" href="../bower_components/codemirror/lib/codemirror.css">
|
||||||
|
<style>
|
||||||
|
.CodeMirror {
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
height: 100%;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script src="./index.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
24
Examples/CodeMirror/index.js
Normal file
24
Examples/CodeMirror/index.js
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
/* global Y, CodeMirror */
|
||||||
|
|
||||||
|
// initialize a shared object. This function call returns a promise!
|
||||||
|
Y({
|
||||||
|
db: {
|
||||||
|
name: 'memory'
|
||||||
|
},
|
||||||
|
connector: {
|
||||||
|
name: 'websockets-client',
|
||||||
|
room: 'codemirror-example'
|
||||||
|
},
|
||||||
|
sourceDir: '/bower_components',
|
||||||
|
share: {
|
||||||
|
codemirror: 'Text' // y.share.codemirror is of type Y.Text
|
||||||
|
}
|
||||||
|
}).then(function (y) {
|
||||||
|
window.yCodeMirror = y
|
||||||
|
|
||||||
|
var editor = CodeMirror(document.querySelector('#codeMirrorContainer'), {
|
||||||
|
mode: 'javascript',
|
||||||
|
lineNumbers: true
|
||||||
|
})
|
||||||
|
y.share.codemirror.bindCodeMirror(editor)
|
||||||
|
})
|
||||||
24
Examples/Monaco/index.html
Normal file
24
Examples/Monaco/index.html
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="monacoContainer"></div>
|
||||||
|
<style>
|
||||||
|
#monacoContainer {
|
||||||
|
position: fixed;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
height: 100%;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script src="../bower_components/yjs/y.es6"></script>
|
||||||
|
<script src="../bower_components/y-array/y-array.es6"></script>
|
||||||
|
<script src="../bower_components/y-text/y-text.es6"></script>
|
||||||
|
<script src="../bower_components/y-websockets-client/y-websockets-client.es6"></script>
|
||||||
|
<script src="../bower_components/y-memory/y-memory.es6"></script>
|
||||||
|
<script src="../node_modules/monaco-editor/min/vs/loader.js"></script>
|
||||||
|
<script src="./index.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
31
Examples/Monaco/index.js
Normal file
31
Examples/Monaco/index.js
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
/* global Y */
|
||||||
|
|
||||||
|
require.config({ paths: { 'vs': '../node_modules/monaco-editor/min/vs' }})
|
||||||
|
require(['vs/editor/editor.main'], function() {
|
||||||
|
|
||||||
|
// Initialize a shared object. This function call returns a promise!
|
||||||
|
Y({
|
||||||
|
db: {
|
||||||
|
name: 'memory'
|
||||||
|
},
|
||||||
|
connector: {
|
||||||
|
name: 'websockets-client',
|
||||||
|
room: 'monaco-example'
|
||||||
|
},
|
||||||
|
sourceDir: '/bower_components',
|
||||||
|
share: {
|
||||||
|
monaco: 'Text' // y.share.monaco is of type Y.Text
|
||||||
|
}
|
||||||
|
}).then(function (y) {
|
||||||
|
window.yMonaco = y
|
||||||
|
|
||||||
|
// Create Monaco editor
|
||||||
|
var editor = monaco.editor.create(document.getElementById('monacoContainer'), {
|
||||||
|
language: 'javascript'
|
||||||
|
})
|
||||||
|
|
||||||
|
// Bind to y.share.monaco
|
||||||
|
y.share.monaco.bindMonaco(editor)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
31
Examples/ServiceWorker/index.html
Normal file
31
Examples/ServiceWorker/index.html
Normal file
@@ -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>
|
||||||
49
Examples/ServiceWorker/index.js
Normal file
49
Examples/ServiceWorker/index.js
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
/* global Y, Quill */
|
||||||
|
|
||||||
|
// register yjs service worker
|
||||||
|
if('serviceWorker' in navigator){
|
||||||
|
// Register service worker
|
||||||
|
// it is important to copy yjs-sw-template to the root directory!
|
||||||
|
navigator.serviceWorker.register('./yjs-sw-template.js').then(function(reg){
|
||||||
|
console.log("Yjs service worker registration succeeded. Scope is " + reg.scope);
|
||||||
|
}).catch(function(err){
|
||||||
|
console.error("Yjs service worker registration failed with error " + err);
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// initialize a shared object. This function call returns a promise!
|
||||||
|
Y({
|
||||||
|
db: {
|
||||||
|
name: 'memory'
|
||||||
|
},
|
||||||
|
connector: {
|
||||||
|
name: 'serviceworker',
|
||||||
|
room: 'ServiceWorkerExample2'
|
||||||
|
},
|
||||||
|
sourceDir: '/bower_components',
|
||||||
|
share: {
|
||||||
|
richtext: 'Richtext' // y.share.richtext is of type Y.Richtext
|
||||||
|
}
|
||||||
|
}).then(function (y) {
|
||||||
|
window.yServiceWorker = 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)
|
||||||
|
})
|
||||||
22
Examples/ServiceWorker/yjs-sw-template.js
Normal file
22
Examples/ServiceWorker/yjs-sw-template.js
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
/* eslint-env worker */
|
||||||
|
|
||||||
|
// copy and modify this file
|
||||||
|
|
||||||
|
self.DBConfig = {
|
||||||
|
name: 'indexeddb'
|
||||||
|
}
|
||||||
|
self.ConnectorConfig = {
|
||||||
|
name: 'websockets-client',
|
||||||
|
// url: '..',
|
||||||
|
options: {
|
||||||
|
jsonp: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
importScripts(
|
||||||
|
'/bower_components/yjs/y.js',
|
||||||
|
'/bower_components/y-memory/y-memory.js',
|
||||||
|
'/bower_components/y-indexeddb/y-indexeddb.js',
|
||||||
|
'/bower_components/y-websockets-client/y-websockets-client.js',
|
||||||
|
'/bower_components/y-serviceworker/yjs-sw-include.js'
|
||||||
|
)
|
||||||
@@ -8,6 +8,7 @@ Y({
|
|||||||
connector: {
|
connector: {
|
||||||
name: 'websockets-client',
|
name: 'websockets-client',
|
||||||
room: 'Textarea-example'
|
room: 'Textarea-example'
|
||||||
|
// url: '127.0.0.1:1234'
|
||||||
},
|
},
|
||||||
sourceDir: '/bower_components',
|
sourceDir: '/bower_components',
|
||||||
share: {
|
share: {
|
||||||
|
|||||||
@@ -23,6 +23,7 @@
|
|||||||
"ace": "~1.2.3",
|
"ace": "~1.2.3",
|
||||||
"ace-builds": "~1.2.3",
|
"ace-builds": "~1.2.3",
|
||||||
"jquery": "~2.2.2",
|
"jquery": "~2.2.2",
|
||||||
"d3": "^3.5.16"
|
"d3": "^3.5.16",
|
||||||
|
"codemirror": "^5.25.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
10
Examples/package.json
Normal file
10
Examples/package.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"name": "examples",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "",
|
||||||
|
"author": "Kevin Jahns",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"monaco-editor": "^0.8.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
174
README.md
174
README.md
@@ -1,17 +1,19 @@
|
|||||||
|
|
||||||
# 
|
# 
|
||||||
|
|
||||||
Yjs is a framework for offline-first p2p shared editing on structured data like text, richtext, json, or XML.
|
Yjs is a framework for offline-first p2p shared editing on structured data like
|
||||||
It is fairly easy to get started, as Yjs hides most of the complexity of concurrent editing.
|
text, richtext, json, or XML. It is fairly easy to get started, as Yjs hides
|
||||||
For additional information, demos, and tutorials visit [y-js.org](http://y-js.org/).
|
most of the complexity of concurrent editing. For additional information, demos,
|
||||||
|
and tutorials visit [y-js.org](http://y-js.org/).
|
||||||
|
|
||||||
### 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
|
||||||
|
|
||||||
Connectors, Databases, and Types are available as modules that extend Yjs. Here is a list of the modules we know of:
|
Connectors, Databases, and Types are available as modules that extend Yjs. Here
|
||||||
|
is a list of the modules we know of:
|
||||||
|
|
||||||
##### Connectors
|
##### Connectors
|
||||||
|
|
||||||
@@ -38,17 +40,25 @@ Connectors, Databases, and Types are available as modules that extend Yjs. Here
|
|||||||
|[map](https://github.com/y-js/y-map) | A shared Map implementation. Maps from text to any stringify-able object |
|
|[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 |
|
|[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 |
|
|[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*>) |
|
|[text](https://github.com/y-js/y-text) | Collaborate on text. Supports two way binding to the [Ace Editor](https://ace.c9.io), [CodeMirror](https://codemirror.net/), [Monaco](https://github.com/Microsoft/monaco-editor), 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/)|
|
|[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!
|
##### Other
|
||||||
Install Yjs, and its modules with [bower](http://bower.io/), or [npm](https://www.npmjs.org/package/yjs).
|
|
||||||
|
| Name | Description |
|
||||||
|
|-----------|-------------------|
|
||||||
|
|[y-element](http://y-js.org/y-element/) | Yjs Polymer Element |
|
||||||
|
|
||||||
|
## Use it!
|
||||||
|
Install Yjs, and its modules with [bower](http://bower.io/), or
|
||||||
|
[npm](https://www.npmjs.org/package/yjs).
|
||||||
|
|
||||||
### Bower
|
### Bower
|
||||||
```
|
```
|
||||||
bower install --save yjs y-array % add all y-* modules you want to use
|
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.
|
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>
|
<script src="./bower_components/yjs/y.js"></script>
|
||||||
```
|
```
|
||||||
@@ -58,7 +68,8 @@ You only need to include the `y.js` file. Yjs is able to automatically require m
|
|||||||
npm install --save yjs % add all y-* modules you want to use
|
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)
|
If you don't include via script tag, you have to explicitly include all modules!
|
||||||
|
(Same goes for other module systems)
|
||||||
```
|
```
|
||||||
var Y = require('yjs')
|
var Y = require('yjs')
|
||||||
require('y-array')(Y) // add the y-array type to Yjs
|
require('y-array')(Y) // add the y-array type to Yjs
|
||||||
@@ -107,7 +118,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: {
|
||||||
@@ -116,7 +127,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'))
|
||||||
})
|
})
|
||||||
@@ -129,23 +140,41 @@ Here is a simple example of a shared textarea
|
|||||||
## Get Help & Give Help
|
## Get Help & Give Help
|
||||||
There are some friendly people on [](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!
|
There are some friendly people on [](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.
|
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
|
# API
|
||||||
|
|
||||||
### 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
|
||||||
* Have a look at the used database adapter repository to see all available options.
|
`options.db.name`.
|
||||||
|
* Have a look at the used database adapter repository to see all available
|
||||||
|
options.
|
||||||
* options.connector
|
* options.connector
|
||||||
* 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
|
||||||
* All our connectors implement a `room` property. Clients that specify the same room share the same data.
|
`options.connector.name`.
|
||||||
* All of our connectors specify an `url` property that defines the connection endpoint of the used connector.
|
* All our connectors implement a `room` property. Clients that specify the
|
||||||
* All of our connectors also have a default connection endpoint that you can use for development.
|
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.
|
||||||
|
* 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.
|
||||||
|
* *Only if you know what you are doing:* Set
|
||||||
|
`options.connector.preferUntransformed = true` in order receive the shared
|
||||||
|
data untransformed. This is very efficient as the database content is simply
|
||||||
|
copied to this client. This does only work if this client receives content
|
||||||
|
from only one client.
|
||||||
* options.sourceDir (browser only)
|
* options.sourceDir (browser only)
|
||||||
* Path where all y-* modules are stored
|
* Path where all y-* modules are stored
|
||||||
* Defaults to `/bower_components`
|
* Defaults to `/bower_components`
|
||||||
@@ -153,23 +182,34 @@ 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
|
||||||
* E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and create an y-array type on `y.share[arbitraryName]`.
|
users.
|
||||||
* If userA doesn't specify `options.share[arbitraryName]`, it won't be available for userA.
|
* E.g. Specify `options.share[arbitraryName] = 'Array'` to require y-array and
|
||||||
* If userB specifies `options.share[arbitraryName]`, it still won't be available for userA. But all the updates are send from userB to userA.
|
create an y-array type on `y.share[arbitraryName]`.
|
||||||
* 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.*`
|
* If userA doesn't specify `options.share[arbitraryName]`, it won't be
|
||||||
* Weird behavior: It is supported that two users specify different types with the same property name.
|
available for userA.
|
||||||
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
|
* 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)
|
* options.type (browser only)
|
||||||
* Array of modules that Yjs needs to require, before instantiating a shared type.
|
* Array of modules that Yjs needs to require, before instantiating a shared
|
||||||
* By default Yjs requires the specified database adapter, the specified connector, and all modules that are used in `options.share.*`
|
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.*
|
* Put all types here that you intend to use, but are not used in y.share.*
|
||||||
|
|
||||||
### Instantiated Y object (y)
|
### Instantiated Y object (y)
|
||||||
@@ -179,7 +219,8 @@ require('y-map')(Y)
|
|||||||
* The specified database adapter is loaded
|
* The specified database adapter is loaded
|
||||||
* The specified connector is loaded
|
* The specified connector is loaded
|
||||||
* All types are included
|
* All types are included
|
||||||
* The connector is initialized, and a unique user id is set (received from the server)
|
* 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`
|
* Note: When using y-indexeddb, a retrieved user id is stored on `localStorage`
|
||||||
|
|
||||||
The promise returns an instance of Y. We denote it with a lower case `y`.
|
The promise returns an instance of Y. We denote it with a lower case `y`.
|
||||||
@@ -197,7 +238,8 @@ The promise returns an instance of Y. We denote it with a lower case `y`.
|
|||||||
* y.connector.disconnect()
|
* y.connector.disconnect()
|
||||||
* Force to disconnect this instance from the other instances
|
* Force to disconnect this instance from the other instances
|
||||||
* y.connector.reconnect()
|
* y.connector.reconnect()
|
||||||
* Try to reconnect to the other instances (needs to be supported by the connector)
|
* Try to reconnect to the other instances (needs to be supported by the
|
||||||
|
connector)
|
||||||
* Not supported by y-xmpp
|
* Not supported by y-xmpp
|
||||||
* y.close()
|
* y.close()
|
||||||
* Destroy this object.
|
* Destroy this object.
|
||||||
@@ -209,62 +251,44 @@ The promise returns an instance of Y. We denote it with a lower case `y`.
|
|||||||
* Removes all data from the database
|
* Removes all data from the database
|
||||||
* Returns a promise
|
* Returns a promise
|
||||||
* y.db.stopGarbageCollector()
|
* y.db.stopGarbageCollector()
|
||||||
* Stop the garbage collector. Call y.db.garbageCollect() to continue garbage collection
|
* Stop the garbage collector. Call y.db.garbageCollect() to continue garbage
|
||||||
|
collection
|
||||||
* y.db.gc :: Boolean
|
* y.db.gc :: Boolean
|
||||||
* Whether gc is turned on
|
* Whether gc is turned on
|
||||||
* y.db.gcTimeout :: Number (defaults to 50000 ms)
|
* y.db.gcTimeout :: Number (defaults to 50000 ms)
|
||||||
* Time interval between two garbage collect cycles
|
* 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)
|
* It is required that all instances exchanged all messages after two garbage
|
||||||
|
collect cycles (after 100000 ms per default)
|
||||||
* y.db.userId :: String
|
* y.db.userId :: String
|
||||||
* The used user id for this client. **Never overwrite this**
|
* The used user id for this client. **Never overwrite this**
|
||||||
|
|
||||||
## Changelog
|
### Logging
|
||||||
|
Yjs uses [debug](https://github.com/visionmedia/debug) for logging. The flag
|
||||||
|
`y*` enables logging for all y-* components. You can selectively remove
|
||||||
|
components you are not interested in: E.g. The flag `y*,-y:connector-message`
|
||||||
|
will not log the long `y:connector-message` messages.
|
||||||
|
|
||||||
### 12.0.0
|
##### Enable logging in Node.js
|
||||||
* **Types are synchronous and never return a promise (except explicitly stated)**
|
```sh
|
||||||
* `y.share.map.get('map type') // => returns a y-map instead of a promise`
|
DEBUG=y* node app.js
|
||||||
* 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
|
Remove the colors in order to log to a file:
|
||||||
|
```sh
|
||||||
* **All types return a single event instead of list of events**
|
DEBUG_COLORS=0 DEBUG=y* node app.js > log
|
||||||
* 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
|
|
||||||
* Y.Map exchanges `.val(name [, value])` in favor of `.set(name, value)` and `.get(name)`
|
|
||||||
* Y.Map `.get(name)` returns a promise, if the value is a custom type
|
|
||||||
* The Connector definition slightly changed (I'll update the wiki)
|
|
||||||
* The Type definitions completely changed, so you have to rewrite them (I'll rewrite the article in the wiki)
|
|
||||||
* Support for several packaging systems
|
|
||||||
* Flowtype
|
|
||||||
|
|
||||||
|
##### Enable logging in the browser
|
||||||
|
```js
|
||||||
|
localStorage.debug = 'y*'
|
||||||
|
```
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
I created this framework during my bachelor thesis at the chair of computer science 5 [(i5)](http://dbis.rwth-aachen.de/cms), RWTH University. Since December 2014 I'm working on Yjs as a part of my student worker job at the i5.
|
I created this framework during my bachelor thesis at the chair of computer
|
||||||
|
science 5 [(i5)](http://dbis.rwth-aachen.de/cms), RWTH University. Since
|
||||||
|
December 2014 I'm working on Yjs as a part of my student worker job at the i5.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
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>
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "yjs",
|
"name": "yjs",
|
||||||
"version": "12.1.1",
|
"version": "12.2.1",
|
||||||
"homepage": "y-js.org",
|
"homepage": "y-js.org",
|
||||||
"authors": [
|
"authors": [
|
||||||
"Kevin Jahns <kevin.jahns@rwth-aachen.de>"
|
"Kevin Jahns <kevin.jahns@rwth-aachen.de>"
|
||||||
|
|||||||
Reference in New Issue
Block a user