back to .js extension

bindings/dom.js

@@ -0,0 +1 @@
+export * from './dom/DomBinding.js'

bindings/dom.mjs

@@ -1 +0,0 @@
-export * from './dom/DomBinding.mjs'

bindings/dom/DomBinding.js

@@ -4,14 +4,14 @@
 
 /* global MutationObserver, getSelection */
 
-import { fromRelativePosition } from '../../utils/relativePosition.mjs'
-import { createMutex } from '../../lib/mutex.mjs'
-import { createAssociation, removeAssociation } from './util.mjs'
-import { beforeTransactionSelectionFixer, afterTransactionSelectionFixer, getCurrentRelativeSelection } from './selection.mjs'
-import { defaultFilter, applyFilterOnType } from './filter.mjs'
-import { typeObserver } from './typeObserver.mjs'
-import { domObserver } from './domObserver.mjs'
-import { YXmlFragment } from '../../types/YXmlElement.mjs' // eslint-disable-line
+import { fromRelativePosition } from '../../utils/relativePosition.js'
+import { createMutex } from '../../lib/mutex.js'
+import { createAssociation, removeAssociation } from './util.js'
+import { beforeTransactionSelectionFixer, afterTransactionSelectionFixer, getCurrentRelativeSelection } from './selection.js'
+import { defaultFilter, applyFilterOnType } from './filter.js'
+import { typeObserver } from './typeObserver.js'
+import { domObserver } from './domObserver.js'
+import { YXmlFragment } from '../../types/YXmlElement.js' // eslint-disable-line
 
 /**
  * @callback DomFilter

bindings/dom/domObserver.js

@@ -2,13 +2,13 @@
  * @module bindings/dom
  */
 
-import { YXmlHook } from '../../types/YXmlHook.mjs'
+import { YXmlHook } from '../../types/YXmlHook.js'
 import {
   iterateUntilUndeleted,
   removeAssociation,
-  insertNodeHelper } from './util.mjs'
-import { simpleDiff } from '../../lib/diff.mjs'
-import { YXmlFragment } from '../../types/YXmlElement.mjs'
+  insertNodeHelper } from './util.js'
+import { simpleDiff } from '../../lib/diff.js'
+import { YXmlFragment } from '../../types/YXmlElement.js'
 
 /**
  * 1. Check if any of the nodes was deleted
@@ -20,6 +20,8 @@ import { YXmlFragment } from '../../types/YXmlElement.mjs'
  *       recreate a new yxml element that is bound to that node.
  *       You can detect that a node was moved because expectedId
  *       !== actualId in the list
+ *
+ * @function
  * @private
  */
 const applyChangesFromDom = (binding, dom, yxml, _document) => {
@@ -85,6 +87,7 @@ const applyChangesFromDom = (binding, dom, yxml, _document) => {
 
 /**
  * @private
+ * @function
  */
 export function domObserver (mutations, _document) {
   this._mutualExclude(() => {

bindings/dom/domToType.js

@@ -3,12 +3,12 @@
  */
 
 /* eslint-env browser */
-import { YXmlText } from '../../types/YXmlText.mjs'
-import { YXmlHook } from '../../types/YXmlHook.mjs'
-import { YXmlElement } from '../../types/YXmlElement.mjs'
-import { createAssociation, domsToTypes } from './util.mjs'
-import { filterDomAttributes, defaultFilter } from './filter.mjs'
-import { DomBinding } from './DomBinding.mjs' // eslint-disable-line
+import { YXmlText } from '../../types/YXmlText.js'
+import { YXmlHook } from '../../types/YXmlHook.js'
+import { YXmlElement } from '../../types/YXmlElement.js'
+import { createAssociation, domsToTypes } from './util.js'
+import { filterDomAttributes, defaultFilter } from './filter.js'
+import { DomBinding } from './DomBinding.js' // eslint-disable-line
 
 /**
  * @callback DomFilter
@@ -20,6 +20,7 @@ import { DomBinding } from './DomBinding.mjs' // eslint-disable-line
 /**
  * Creates a Yjs type (YXml) based on the contents of a DOM Element.
  *
+ * @function
  * @param {Element|Text} element The DOM Element
  * @param {?Document} _document Optional. Provide the global document object
  * @param {Object<string, any>} [hooks = {}] Optional. Set of Yjs Hooks

bindings/dom/filter.js

@@ -2,14 +2,15 @@
  * @module bindings/dom
  */
 
-import { Y } from '../../utils/Y.mjs' // eslint-disable-line
-import { YXmlElement, YXmlFragment } from '../../types/YXmlElement.mjs' // eslint-disable-line
-import { isParentOf } from '../../utils/isParentOf.mjs'
-import { DomBinding } from './DomBinding.mjs' // eslint-disable-line
+import { Y } from '../../utils/Y.js' // eslint-disable-line
+import { YXmlElement, YXmlFragment } from '../../types/YXmlElement.js' // eslint-disable-line
+import { isParentOf } from '../../utils/isParentOf.js'
+import { DomBinding } from './DomBinding.js' // eslint-disable-line
 
 /**
  * Default filter method (does nothing).
  *
+ * @function
  * @param {String} nodeName The nodeName of the element
  * @param {Map} attrs Map of key-value pairs that are attributes of the node.
  * @return {Map | null} The allowed attributes or null, if the element should be
@@ -21,7 +22,10 @@ export const defaultFilter = (nodeName, attrs) => {
 }
 
 /**
- *
+ * @private
+ * @function
+ * @param {Element} dom
+ * @param {Function} filter
  */
 export const filterDomAttributes = (dom, filter) => {
   const attrs = new Map()
@@ -35,11 +39,11 @@ export const filterDomAttributes = (dom, filter) => {
 /**
  * Applies a filter on a type.
  *
+ * @private
+ * @function
  * @param {Y} y The Yjs instance.
  * @param {DomBinding} binding The DOM binding instance that has the dom filter.
  * @param {YXmlElement | YXmlFragment } type The type to apply the filter to.
- *
- * @private
  */
 export const applyFilterOnType = (y, binding, type) => {
   if (isParentOf(binding.type, type) && type instanceof YXmlElement) {

bindings/dom/selection.js

@@ -4,10 +4,13 @@
 
 /* globals getSelection */
 
-import { getRelativePosition } from '../../utils/relativePosition.mjs'
+import { getRelativePosition } from '../../utils/relativePosition.js'
 
 let relativeSelection = null
 
+/**
+ * @private
+ */
 const _getCurrentRelativeSelection = domBinding => {
   const { baseNode, baseOffset, extentNode, extentOffset } = getSelection()
   const baseNodeType = domBinding.domToType.get(baseNode)
@@ -21,8 +24,14 @@ const _getCurrentRelativeSelection = domBinding => {
   return null
 }
 
+/**
+ * @private
+ */
 export const getCurrentRelativeSelection = typeof getSelection !== 'undefined' ? _getCurrentRelativeSelection : domBinding => null
 
+/**
+ * @private
+ */
 export const beforeTransactionSelectionFixer = domBinding => {
   relativeSelection = getCurrentRelativeSelection(domBinding)
 }
@@ -30,6 +39,7 @@ export const beforeTransactionSelectionFixer = domBinding => {
 /**
  * Reset the browser range after every transaction.
  * This prevents any collapsing issues with the local selection.
+ *
  * @private
  */
 export const afterTransactionSelectionFixer = domBinding => {

bindings/dom/typeObserver.js

@@ -5,9 +5,9 @@
 /* eslint-env browser */
 /* global getSelection */
 
-import { YXmlText } from '../../types/YXmlText.mjs'
-import { YXmlHook } from '../../types/YXmlHook.mjs'
-import { removeDomChildrenUntilElementFound } from './util.mjs'
+import { YXmlText } from '../../types/YXmlText.js'
+import { YXmlHook } from '../../types/YXmlHook.js'
+import { removeDomChildrenUntilElementFound } from './util.js'
 
 const findScrollReference = scrollingElement => {
   if (scrollingElement !== null) {

bindings/dom/util.js

@@ -2,8 +2,8 @@
  * @module bindings/dom
  */
 
-import { domToType } from './domToType.mjs'
-import { DomBinding } from './DomBinding.mjs' // eslint-disable-line
+import { domToType } from './domToType.js'
+import { DomBinding } from './DomBinding.js' // eslint-disable-line
 
 /**
  * Iterates items until an undeleted item is found.
@@ -22,6 +22,7 @@ export const iterateUntilUndeleted = item => {
  * type).
  *
  * @private
+ * @function
  * @param {DomBinding} domBinding The binding object
  * @param {Element} dom The dom that is to be associated with type
  * @param {YXmlElement|YXmlHook} type The type that is to be associated with dom
@@ -37,6 +38,7 @@ export const removeAssociation = (domBinding, dom, type) => {
  * type).
  *
  * @private
+ * @function
  * @param {DomBinding} domBinding The binding object
  * @param {DocumentFragment|Element|Text} dom The dom that is to be associated with type
  * @param {YXmlFragment|YXmlElement|YXmlHook|YXmlText} type The type that is to be associated with dom
@@ -54,6 +56,7 @@ export const createAssociation = (domBinding, dom, type) => {
  * forget about oldDom. If oldDom is not associated with any type, nothing happens.
  *
  * @private
+ * @function
  * @param {DomBinding} domBinding The binding object
  * @param {Element} oldDom The existing dom
  * @param {Element} newDom The new dom object
@@ -74,6 +77,7 @@ export const switchAssociation = (domBinding, oldDom, newDom) => {
  * specified position.
  *
  * @private
+ * @function
  * @param {YXmlElement} type The type in which to insert DOM elements.
  * @param {YXmlElement|null} prev The reference node. New YxmlElements are
  *                           inserted after this node. Set null to insert at
@@ -101,6 +105,7 @@ export const domsToTypes = (doms, _document, hooks, filter, binding) => {
 
 /**
  * @private
+ * @function
  */
 export const insertNodeHelper = (yxml, prevExpectedNode, child, _document, binding) => {
   let insertedNodes = insertDomElementsAfter(yxml, prevExpectedNode, [child], _document, binding)
@@ -115,6 +120,7 @@ export const insertNodeHelper = (yxml, prevExpectedNode, child, _document, bindi
  * Remove children until `elem` is found.
  *
  * @private
+ * @function
  * @param {Element} parent The parent of `elem` and `currentChild`.
  * @param {Node} currentChild Start removing elements with `currentChild`. If
  *                               `currentChild` is `elem` it won't be removed.

bindings/prosemirror.js

@@ -2,10 +2,10 @@
  * @module bindings/prosemirror
  */
 
-import { BindMapping } from '../utils/BindMapping.mjs'
-import { YText } from '../types/YText.mjs' // eslint-disable-line
-import { YXmlElement, YXmlFragment } from '../types/YXmlElement.mjs' // eslint-disable-line
-import { createMutex } from '../lib/mutex.mjs'
+import { BindMapping } from '../utils/BindMapping.js'
+import { YText } from '../types/YText.js' // eslint-disable-line
+import { YXmlElement, YXmlFragment } from '../types/YXmlElement.js' // eslint-disable-line
+import { createMutex } from '../lib/mutex.js'
 import * as PModel from 'prosemirror-model'
 import { EditorView,  Decoration, DecorationSet } from 'prosemirror-view' // eslint-disable-line
 import { Plugin, PluginKey, EditorState } from 'prosemirror-state' // eslint-disable-line

bindings/quill.js

@@ -2,7 +2,7 @@
  * @module bindings/quill
  */
 
-import { createMutex } from '../lib/mutex.mjs'
+import { createMutex } from '../lib/mutex.js'
 
 const typeObserver = function (event) {
   const quill = this.target
@@ -53,7 +53,6 @@ export class QuillBinding {
      * @private
      */
     this._mutualExclude = createMutex()
-    
     // Set initial value.
     quill.setContents(textType.toDelta(), 'yjs')
     // Observers are handled by this class.

bindings/textarea.js

@@ -2,9 +2,9 @@
  * @module bindings/textarea
  */
 
-import { simpleDiff } from '../lib/diff.mjs'
-import { getRelativePosition, fromRelativePosition } from '../utils/relativePosition.mjs'
-import { createMutex } from '../lib/mutex.mjs'
+import { simpleDiff } from '../lib/diff.js'
+import { getRelativePosition, fromRelativePosition } from '../utils/relativePosition.js'
+import { createMutex } from '../lib/mutex.js'
 
 function typeObserver () {
   this._mutualExclude(() => {