@y/y 14.0.0-16 → 14.0.0-18

package/src/types/YXmlElement.js

@@ -1,227 +0,0 @@
-import * as object from 'lib0/object'
-
-import {
-  YXmlFragment,
-  transact,
-  typeMapDelete,
-  typeMapHas,
-  typeMapSet,
-  typeMapGet,
-  typeMapGetAll,
-  typeMapGetAllSnapshot,
-  YXmlElementRefID,
-  Snapshot, YXmlText, ContentType, AbstractType, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Item, // eslint-disable-line
-} from '../internals.js'
-
-/**
- * @typedef {Object|number|null|Array<any>|string|Uint8Array|AbstractType<any>} ValueTypes
- */
-
-/**
- * An YXmlElement imitates the behavior of a
- * https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element
- *
- * * An YXmlElement has attributes (key value pairs)
- * * An YXmlElement has childElements that must inherit from YXmlElement
- *
- * @template {{ [key: string]: any }} [Attrs={ [key: string]: string }]
- * @template {any} [Children=any]
- * @extends YXmlFragment<Children,Attrs>
- */
-export class YXmlElement extends YXmlFragment {
-  constructor (nodeName = 'UNDEFINED') {
-    super()
-    this.nodeName = nodeName
-    /**
-     * @type {Map<string, any>|null}
-     */
-    this._prelimAttrs = new Map()
-  }
-
-  /**
-   * @type {YXmlElement|YXmlText|null}
-   */
-  get nextSibling () {
-    const n = this._item ? this._item.next : null
-    return n ? /** @type {YXmlElement|YXmlText} */ (/** @type {ContentType} */ (n.content).type) : null
-  }
-
-  /**
-   * @type {YXmlElement|YXmlText|null}
-   */
-  get prevSibling () {
-    const n = this._item ? this._item.prev : null
-    return n ? /** @type {YXmlElement|YXmlText} */ (/** @type {ContentType} */ (n.content).type) : null
-  }
-
-  /**
-   * Integrate this type into the Yjs instance.
-   *
-   * * Save this struct in the os
-   * * This type is sent to other client
-   * * Observer functions are fired
-   *
-   * @param {Doc} y The Yjs instance
-   * @param {Item?} item
-   */
-  _integrate (y, item) {
-    super._integrate(y, item)
-    ;(/** @type {Map<string, any>} */ (this._prelimAttrs)).forEach((value, key) => {
-      this.setAttribute(key, value)
-    })
-    this._prelimAttrs = null
-  }
-
-  /**
-   * Creates an Item with the same effect as this Item (without position effect)
-   *
-   * @return {this}
-   */
-  _copy () {
-    return /** @type {any} */ (new YXmlElement(this.nodeName))
-  }
-
-  /**
-   * Makes a copy of this data type that can be included somewhere else.
-   *
-   * Note that the content is only readable _after_ it has been included somewhere in the Ydoc.
-   *
-   * @return {this}
-   */
-  clone () {
-    const el = this._copy()
-    const attrs = this.getAttributes()
-    object.forEach(attrs, (value, key) => {
-      if (typeof value === 'string') {
-        el.setAttribute(key, value)
-      }
-    })
-    // @ts-ignore
-    el.insert(0, this.toArray().map(item => item instanceof AbstractType ? item.clone() : item))
-    return el
-  }
-
-  /**
-   * Returns the XML serialization of this YXmlElement.
-   * The attributes are ordered by attribute-name, so you can easily use this
-   * method to compare YXmlElements
-   *
-   * @return {string} The string representation of this type.
-   *
-   * @public
-   */
-  toString () {
-    const attrs = this.getAttributes()
-    const stringBuilder = []
-    const keys = []
-    for (const key in attrs) {
-      keys.push(key)
-    }
-    keys.sort()
-    const keysLen = keys.length
-    for (let i = 0; i < keysLen; i++) {
-      const key = keys[i]
-      stringBuilder.push(key + '="' + attrs[key] + '"')
-    }
-    const nodeName = this.nodeName.toLocaleLowerCase()
-    const attrsString = stringBuilder.length > 0 ? ' ' + stringBuilder.join(' ') : ''
-    return `<${nodeName}${attrsString}>${super.toString()}</${nodeName}>`
-  }
-
-  /**
-   * Removes an attribute from this YXmlElement.
-   *
-   * @param {string} attributeName The attribute name that is to be removed.
-   *
-   * @public
-   */
-  removeAttribute (attributeName) {
-    if (this.doc !== null) {
-      transact(this.doc, transaction => {
-        typeMapDelete(transaction, this, attributeName)
-      })
-    } else {
-      /** @type {Map<string,any>} */ (this._prelimAttrs).delete(attributeName)
-    }
-  }
-
-  /**
-   * Sets or updates an attribute.
-   *
-   * @template {keyof Attrs & string} KEY
-   *
-   * @param {KEY} attributeName The attribute name that is to be set.
-   * @param {Attrs[KEY]} attributeValue The attribute value that is to be set.
-   *
-   * @public
-   */
-  setAttribute (attributeName, attributeValue) {
-    if (this.doc !== null) {
-      transact(this.doc, transaction => {
-        typeMapSet(transaction, this, attributeName, /** @type {any} */ (attributeValue))
-      })
-    } else {
-      /** @type {Map<string, any>} */ (this._prelimAttrs).set(attributeName, attributeValue)
-    }
-  }
-
-  /**
-   * Returns an attribute value that belongs to the attribute name.
-   *
-   * @template {keyof Attrs & string} KEY
-   *
-   * @param {KEY} attributeName The attribute name that identifies the
-   *                               queried value.
-   * @return {Attrs[KEY]|undefined} The queried attribute value.
-   *
-   * @public
-   */
-  getAttribute (attributeName) {
-    return /** @type {any} */ (typeMapGet(this, attributeName))
-  }
-
-  /**
-   * Returns whether an attribute exists
-   *
-   * @param {string} attributeName The attribute name to check for existence.
-   * @return {boolean} whether the attribute exists.
-   *
-   * @public
-   */
-  hasAttribute (attributeName) {
-    return /** @type {any} */ (typeMapHas(this, attributeName))
-  }
-
-  /**
-   * Returns all attribute name/value pairs in a JSON Object.
-   *
-   * @param {Snapshot} [snapshot]
-   * @return {{ [Key in Extract<keyof Attrs,string>]?: Attrs[Key]}} A JSON Object that describes the attributes.
-   *
-   * @public
-   */
-  getAttributes (snapshot) {
-    return /** @type {any} */ (snapshot ? typeMapGetAllSnapshot(this, snapshot) : typeMapGetAll(this))
-  }
-
-  /**
-   * Transform the properties of this type to binary and write it to an
-   * BinaryEncoder.
-   *
-   * This is called when this Item is sent to a remote peer.
-   *
-   * @param {UpdateEncoderV1 | UpdateEncoderV2} encoder The encoder to write data to.
-   */
-  _write (encoder) {
-    encoder.writeTypeRef(YXmlElementRefID)
-    encoder.writeKey(this.nodeName)
-  }
-}
-
-/**
- * @param {UpdateDecoderV1 | UpdateDecoderV2} decoder
- * @return {import('../utils/types.js').YType}
- *
- * @function
- */
-export const readYXmlElement = decoder => new YXmlElement(decoder.readKey())

package/src/types/YXmlFragment.js

@@ -1,266 +0,0 @@
-/**
- * @module YXml
- */
-
-import {
-  AbstractType,
-  typeListMap,
-  typeListForEach,
-  typeListInsertGenerics,
-  typeListInsertGenericsAfter,
-  typeListDelete,
-  typeListToArray,
-  YXmlFragmentRefID,
-  transact,
-  typeListGet,
-  typeListSlice,
-  warnPrematureAccess,
-  YXmlElement, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Transaction, Item, YXmlText, YXmlHook // eslint-disable-line
-} from '../internals.js'
-
-import * as delta from 'lib0/delta' // eslint-disable-line
-import * as error from 'lib0/error'
-
-/**
- * Define the elements to which a set of CSS queries apply.
- * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors|CSS_Selectors}
- *
- * @example
- *   query = '.classSelector'
- *   query = 'nodeSelector'
- *   query = '#idSelector'
- *
- * @typedef {string} CSS_Selector
- */
-
-/**
- * Dom filter function.
- *
- * @callback domFilter
- * @param {string} nodeName The nodeName of the element
- * @param {Map} attributes The map of attributes.
- * @return {boolean} Whether to include the Dom node in the YXmlElement.
- */
-
-/**
- * Represents a list of {@link YXmlElement}.and {@link YXmlText} types.
- * A YxmlFragment is similar to a {@link YXmlElement}, but it does not have a
- * nodeName and it does not have attributes. Though it can be bound to a DOM
- * element - in this case the attributes and the nodeName are not shared.
- *
- * @public
- * @template {any} [Children=any]
- * @template {{[K in string]:any}} [Attrs={}]
- * @extends AbstractType<delta.Delta<any,Attrs,Children,any>>
- */
-export class YXmlFragment extends AbstractType {
-  constructor () {
-    super()
-    /**
-     * @todo remove _prelimContent
-     * @type {Array<any>|null}
-     */
-    this._prelimContent = []
-  }
-
-  /**
-   * @type {YXmlElement|YXmlText|null}
-   */
-  get firstChild () {
-    const first = this._first
-    return first ? first.content.getContent()[0] : null
-  }
-
-  /**
-   * Integrate this type into the Yjs instance.
-   *
-   * * Save this struct in the os
-   * * This type is sent to other client
-   * * Observer functions are fired
-   *
-   * @param {Doc} y The Yjs instance
-   * @param {Item?} item
-   */
-  _integrate (y, item) {
-    super._integrate(y, item)
-    this.insert(0, /** @type {Array<any>} */ (this._prelimContent))
-    this._prelimContent = null
-  }
-
-  /**
-   * Makes a copy of this data type that can be included somewhere else.
-   *
-   * Note that the content is only readable _after_ it has been included somewhere in the Ydoc.
-   *
-   * @return {this}
-   */
-  clone () {
-    const el = this._copy()
-    el.insert(0, this.toArray().map(item => item instanceof AbstractType ? item.clone() : item))
-    return el
-  }
-
-  get length () {
-    this.doc ?? warnPrematureAccess()
-    return this._prelimContent === null ? this._length : this._prelimContent.length
-  }
-
-  /**
-   * Get the string representation of all the children of this YXmlFragment.
-   *
-   * @return {string} The string representation of all children.
-   */
-  toString () {
-    return typeListMap(this, xml => xml.toString()).join('')
-  }
-
-  /**
-   * @return {string}
-   */
-  toJSON () {
-    return this.toString()
-  }
-
-  /**
-   * Inserts new content at an index.
-   *
-   * @example
-   *  // Insert character 'a' at position 0
-   *  xml.insert(0, [new Y.XmlText('text')])
-   *
-   * @param {number} index The index to insert content at
-   * @param {Array<YXmlElement|YXmlText|YXmlHook>} content The array of content
-   */
-  insert (index, content) {
-    if (this.doc !== null) {
-      transact(this.doc, transaction => {
-        typeListInsertGenerics(transaction, this, index, content)
-      })
-    } else {
-      // @ts-ignore _prelimContent is defined because this is not yet integrated
-      this._prelimContent.splice(index, 0, ...content)
-    }
-  }
-
-  /**
-   * Inserts new content at an index.
-   *
-   * @example
-   *  // Insert character 'a' at position 0
-   *  xml.insert(0, [new Y.XmlText('text')])
-   *
-   * @param {null|Item|YXmlElement|YXmlText} ref The index to insert content at
-   * @param {Array<YXmlElement|YXmlText>} content The array of content
-   */
-  insertAfter (ref, content) {
-    if (this.doc !== null) {
-      transact(this.doc, transaction => {
-        const refItem = (ref && ref instanceof AbstractType) ? ref._item : ref
-        typeListInsertGenericsAfter(transaction, this, refItem, content)
-      })
-    } else {
-      const pc = /** @type {Array<any>} */ (this._prelimContent)
-      const index = ref === null ? 0 : pc.findIndex(el => el === ref) + 1
-      if (index === 0 && ref !== null) {
-        throw error.create('Reference item not found')
-      }
-      pc.splice(index, 0, ...content)
-    }
-  }
-
-  /**
-   * Deletes elements starting from an index.
-   *
-   * @param {number} index Index at which to start deleting elements
-   * @param {number} [length=1] The number of elements to remove. Defaults to 1.
-   */
-  delete (index, length = 1) {
-    if (this.doc !== null) {
-      transact(this.doc, transaction => {
-        typeListDelete(transaction, this, index, length)
-      })
-    } else {
-      // @ts-ignore _prelimContent is defined because this is not yet integrated
-      this._prelimContent.splice(index, length)
-    }
-  }
-
-  /**
-   * Transforms this YArray to a JavaScript Array.
-   *
-   * @return {Array<YXmlElement|YXmlText|YXmlHook>}
-   */
-  toArray () {
-    return typeListToArray(this)
-  }
-
-  /**
-   * Appends content to this YArray.
-   *
-   * @param {Array<YXmlElement|YXmlText>} content Array of content to append.
-   */
-  push (content) {
-    this.insert(this.length, content)
-  }
-
-  /**
-   * Prepends content to this YArray.
-   *
-   * @param {Array<YXmlElement|YXmlText>} content Array of content to prepend.
-   */
-  unshift (content) {
-    this.insert(0, content)
-  }
-
-  /**
-   * Returns the i-th element from a YArray.
-   *
-   * @param {number} index The index of the element to return from the YArray
-   * @return {YXmlElement|YXmlText}
-   */
-  get (index) {
-    return typeListGet(this, index)
-  }
-
-  /**
-   * Returns a portion of this YXmlFragment into a JavaScript Array selected
-   * from start to end (end not included).
-   *
-   * @param {number} [start]
-   * @param {number} [end]
-   * @return {Array<YXmlElement|YXmlText>}
-   */
-  slice (start = 0, end = this.length) {
-    return typeListSlice(this, start, end)
-  }
-
-  /**
-   * Executes a provided function on once on every child element.
-   *
-   * @param {function(YXmlElement|YXmlText,number, typeof self):void} f A function to execute on every element of this YArray.
-   */
-  forEach (f) {
-    typeListForEach(this, f)
-  }
-
-  /**
-   * Transform the properties of this type to binary and write it to an
-   * BinaryEncoder.
-   *
-   * This is called when this Item is sent to a remote peer.
-   *
-   * @param {UpdateEncoderV1 | UpdateEncoderV2} encoder The encoder to write data to.
-   */
-  _write (encoder) {
-    encoder.writeTypeRef(YXmlFragmentRefID)
-  }
-}
-
-/**
- * @param {UpdateDecoderV1 | UpdateDecoderV2} _decoder
- * @return {import('../utils/types.js').YType}
- *
- * @private
- * @function
- */
-export const readYXmlFragment = _decoder => new YXmlFragment()

package/src/types/YXmlHook.js

@@ -1,68 +0,0 @@
-import {
-  YMap,
-  YXmlHookRefID,
-  UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2 // eslint-disable-line
-} from '../internals.js'
-
-/**
- * You can manage binding to a custom type with YXmlHook.
- *
- * @extends {YMap<any>}
- */
-export class YXmlHook extends YMap {
-  /**
-   * @param {string} hookName nodeName of the Dom Node.
-   */
-  constructor (hookName) {
-    super()
-    /**
-     * @type {string}
-     */
-    this.hookName = hookName
-  }
-
-  /**
-   * @return {this}
-   */
-  _copy () {
-    return /** @type {this} */ (new YXmlHook(this.hookName))
-  }
-
-  /**
-   * Makes a copy of this data type that can be included somewhere else.
-   *
-   * Note that the content is only readable _after_ it has been included somewhere in the Ydoc.
-   *
-   * @return {this}
-   */
-  clone () {
-    const el = this._copy()
-    this.forEach((value, key) => {
-      el.set(key, value)
-    })
-    return el
-  }
-
-  /**
-   * Transform the properties of this type to binary and write it to an
-   * BinaryEncoder.
-   *
-   * This is called when this Item is sent to a remote peer.
-   *
-   * @param {UpdateEncoderV1 | UpdateEncoderV2} encoder The encoder to write data to.
-   */
-  _write (encoder) {
-    encoder.writeTypeRef(YXmlHookRefID)
-    encoder.writeKey(this.hookName)
-  }
-}
-
-/**
- * @param {UpdateDecoderV1 | UpdateDecoderV2} decoder
- * @return {import('../utils/types.js').YType}
- *
- * @private
- * @function
- */
-export const readYXmlHook = decoder =>
-  new YXmlHook(decoder.readKey())

package/src/types/YXmlText.js

@@ -1,66 +0,0 @@
-import {
-  YText,
-  YXmlTextRefID,
-  ContentType, YXmlElement, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, // eslint-disable-line
-} from '../internals.js'
-
-/**
- * @todo can we deprecate this?
- *
- * Represents text in a Dom Element. In the future this type will also handle
- * simple formatting information like bold and italic.
- * @extends YText
- */
-export class YXmlText extends YText {
-  /**
-   * @type {YXmlElement|YXmlText|null}
-   */
-  get nextSibling () {
-    const n = this._item ? this._item.next : null
-    return n ? /** @type {YXmlElement|YXmlText} */ (/** @type {ContentType} */ (n.content).type) : null
-  }
-
-  /**
-   * @type {YXmlElement|YXmlText|null}
-   */
-  get prevSibling () {
-    const n = this._item ? this._item.prev : null
-    return n ? /** @type {YXmlElement|YXmlText} */ (/** @type {ContentType} */ (n.content).type) : null
-  }
-
-  /**
-   * Makes a copy of this data type that can be included somewhere else.
-   *
-   * Note that the content is only readable _after_ it has been included somewhere in the Ydoc.
-   *
-   * @return {this}
-   */
-  clone () {
-    const text = /** @type {this} */ (this._copy())
-    text.applyDelta(this.getContent())
-    return text
-  }
-
-  /**
-   * @return {string}
-   */
-  toJSON () {
-    return this.toString()
-  }
-
-  /**
-   * @param {UpdateEncoderV1 | UpdateEncoderV2} encoder
-   */
-  _write (encoder) {
-    encoder.writeTypeRef(YXmlTextRefID)
-  }
-}
-
-/**
- * @param {UpdateDecoderV1 | UpdateDecoderV2} _decoder
- * @return {import('../utils/types.js').YType}
- *
- * @private
- * @function
- */
-export const readYXmlText = _decoder => new YXmlText()

package/src/utils/AbstractConnector.js

@@ -1,25 +0,0 @@
-import { ObservableV2 } from 'lib0/observable'
-
-import {
-  Doc // eslint-disable-line
-} from '../internals.js'
-
-/**
- * This is an abstract interface that all Connectors should implement to keep them interchangeable.
- *
- * @note This interface is experimental and it is not advised to actually inherit this class.
- *       It just serves as typing information.
- *
- * @extends {ObservableV2<any>}
- */
-export class AbstractConnector extends ObservableV2 {
-  /**
-   * @param {Doc} ydoc
-   * @param {any} awareness
-   */
-  constructor (ydoc, awareness) {
-    super()
-    this.doc = ydoc
-    this.awareness = awareness
-  }
-}