restructer and move to esdoc

src/Bindings/Binding.js

@@ -0,0 +1,36 @@
+
+import { createMutualExclude } from '../Util/mutualExclude.js'
+
+/**
+ * Abstract class for bindings
+ *
+ * A binding handles data binding from a Yjs type to a data object. For example,
+ * you can bind a Quill editor instance to a YText instance with the `QuillBinding` class.
+ *
+ * It is expected that a concrete implementation accepts two parameters
+ * (type and binding target).
+ *
+ * @example
+ *   const quill = new Quill(document.createElement('div'))
+ *   const type = y.define('quill', Y.Text)
+ *   const binding = new Y.QuillBinding(quill, type)
+ *
+ */
+export default class Binding {
+  /**
+   * @param {YType} type Yjs type
+   * @param {any} target Binding Target
+   */
+  constructor (type, target) {
+    this.type = type
+    this.target = target
+    this._mutualExclude = createMutualExclude()
+  }
+  /**
+   * Remove all data observers (both from the type and th target).
+   */
+  destroy () {
+    this.type = null
+    this.target = null
+  }
+}

src/Bindings/QuillBinding.js

@@ -0,0 +1,48 @@
+import Binding from './Binding.js'
+
+function typeObserver (event) {
+  const quill = this.target
+  quill.update('yjs')
+  this._mutualExclude(function () {
+    quill.updateContents(event.delta, 'yjs')
+    quill.update('yjs') // ignore applied changes
+  })
+}
+
+function quillObserver (delta) {
+  this._mutualExclude(() => {
+    this.type.applyDelta(delta.ops)
+  })
+}
+
+/**
+ * A Binding that binds a YText type to a Quill editor
+ *
+ * @example
+ *   const quill = new Quill(document.createElement('div'))
+ *   const type = y.define('quill', Y.Text)
+ *   const binding = new Y.QuillBinding(quill, type)
+ */
+export default class QuillBinding extends Binding {
+  /**
+   * @param {YText} textType
+   * @param {Quill} quill
+   */
+  constructor (textType, quill) {
+    // Binding handles textType as this.type and quill as this.target
+    super(textType, quill)
+    // set initial value
+    quill.setContents(textType.toDelta(), 'yjs')
+    // Observers are handled by this class
+    this._typeObserver = typeObserver.bind(this)
+    this._quillObserver = quillObserver.bind(this)
+    textType.observe(this._typeObserver)
+    quill.on('text-change', this._quillObserver)
+  }
+  destroy () {
+    // Remove everything that is handled by this class
+    this.type.unobserve(this._typeObserver)
+    this.target.off('text-change', this._quillObserver)
+    super.destroy()
+  }
+}

src/Bindings/TextareaBinding.js

@@ -0,0 +1,56 @@
+
+import Binding from './Binding.js'
+import simpleDiff from '../Util/simpleDiff.js'
+import { getRelativePosition, fromRelativePosition } from '../Util/relativePosition.js'
+
+function typeObserver () {
+  this._mutualExclude(() => {
+    const textarea = this.target
+    const textType = this.type
+    const relativeStart = getRelativePosition(textType, textarea.selectionStart)
+    const relativeEnd = getRelativePosition(textType, textarea.selectionEnd)
+    textarea.value = textType.toString()
+    const start = fromRelativePosition(textType._y, relativeStart)
+    const end = fromRelativePosition(textType._y, relativeEnd)
+    textarea.setSelectionRange(start, end)
+  })
+}
+
+function domObserver () {
+  this._mutualExclude(() => {
+    let diff = simpleDiff(this.type.toString(), this.target.value)
+    this.type.delete(diff.pos, diff.remove)
+    this.type.insert(diff.pos, diff.insert)
+  })
+}
+
+/**
+ * A binding that binds a YText to a dom textarea.
+ *
+ * This binding will automatically be destroyed when it's parent is deleted
+ *
+ * @example
+ *   const textare = document.createElement('textarea')
+ *   const type = y.define('textarea', Y.Text)
+ *   const binding = new Y.QuillBinding(textarea, type)
+ *
+ */
+export default class TextareaBinding extends Binding {
+  constructor (textType, domTextarea) {
+    // Binding handles textType as this.type and domTextarea as this.target
+    super(textType, domTextarea)
+    // set initial value
+    domTextarea.value = textType.toString()
+    // Observers are handled by this class
+    this._typeObserver = typeObserver.bind(this)
+    this._domObserver = domObserver.bind(this)
+    textType.observe(this._typeObserver)
+    domTextarea.addEventListener('input', this._domObserver)
+  }
+  destroy () {
+    // Remove everything that is handled by this class
+    this.type.unobserve(this._typeObserver)
+    this.target.unobserve(this._domObserver)
+    super.destroy()
+  }
+}