@y/y 14.0.0-rc.2 → 14.0.0-rc.20

package/src/structs/Skip.js

@@ -1,13 +1,8 @@
-import {
-  AbstractStruct,
-  addStruct,
-  addToIdSet,
-  UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction, // eslint-disable-line
-  createID
-} from '../internals.js'
-
 import * as encoding from 'lib0/encoding'
 
+import { AbstractStruct } from './AbstractStruct.js'
+import { createID } from '../utils/ID.js'
+
 export const structSkipRefNumber = 10
 
 /**
@@ -41,8 +36,9 @@ export class Skip extends AbstractStruct {
       this.id.clock += offset
       this.length -= offset
     }
-    addToIdSet(transaction.doc.store.skips, this.id.client, this.id.clock, this.length)
-    addStruct(transaction.doc.store, this)
+    const store = transaction.doc.store
+    store.skips.add(this.id.client, this.id.clock, this.length)
+    store.add(this)
   }
 
   /**
@@ -55,15 +51,6 @@ export class Skip extends AbstractStruct {
     encoding.writeVarUint(encoder.restEncoder, this.length - offset)
   }
 
-  /**
-   * @param {Transaction} _transaction
-   * @param {StructStore} _store
-   * @return {null | number}
-   */
-  getMissing (_transaction, _store) {
-    return null
-  }
-
   /**
    * @param {number} diff
    */
@@ -73,3 +60,13 @@ export class Skip extends AbstractStruct {
     return other
   }
 }
+
+/**
+ * @type {10}
+ */
+Skip.prototype.ref = structSkipRefNumber
+
+/**
+ * @type {false}
+ */
+Skip.prototype.isItem = false

package/src/utils/BlockSet.js

@@ -1,15 +1,3 @@
-import {
-  createID,
-  readItemContent,
-  findIndexCleanStart,
-  Skip,
-  createIdSet,
-  sliceStruct,
-  IdRange,
-  GC, Item, ID,
-  writeStructs
-} from '../internals.js'
-
 import * as decoding from 'lib0/decoding'
 import * as binary from 'lib0/binary'
 import * as map from 'lib0/map'
@@ -18,6 +6,16 @@ import * as math from 'lib0/math'
 import * as encoding from 'lib0/encoding'
 import * as number from 'lib0/number'
 
+import { createID, ID } from './ID.js'
+import { Item } from '../structs/Item.js'
+import { readItemContent } from '../ytype.js'
+import { findIndexCleanStart } from './transaction-helpers.js'
+import { Skip } from '../structs/Skip.js'
+import { createIdSet, IdRange } from './ids.js'
+import { sliceStruct } from './updates.js'
+import { GC } from '../structs/GC.js'
+import { writeStructs } from './encoding-helpers.js'
+
 /**
  * @param {UpdateDecoderV1 | UpdateDecoderV2} decoder The decoder object to read data from.
  * @return {BlockSet}
@@ -31,7 +29,7 @@ export const readBlockSet = (decoder) => {
   for (let i = 0; i < numOfStateUpdates; i++) {
     const numberOfBlocks = decoding.readVarUint(decoder.restDecoder)
     /**
-     * @type {Array<GC|Item>}
+     * @type {Array<GC|Item|Skip>}
      */
     const refs = new Array(numberOfBlocks)
     const client = decoder.readClient()
@@ -99,12 +97,12 @@ export const writeBlockSet = (encoder, blocks) => {
 
 class BlockRange {
   /**
-   * @param {Array<Item|GC>} refs
+   * @param {Array<Item|GC|Skip>} refs
    */
   constructor (refs) {
     this.i = 0
     /**
-     * @type {Array<Item | GC>}
+     * @type {Array<Item | GC | Skip>}
      */
     this.refs = refs
   }
@@ -196,17 +194,19 @@ export class BlockSet {
           if (gapSize > 0) {
             leftRanges.push(new Skip(new ID(clientid, lastBlockLeft.id.clock + lastBlockLeft.length), gapSize))
           }
-          leftRanges.push(...rightRanges)
+          for (let i = 0; i < rightRanges.length; i++) {
+            leftRanges.push(rightRanges[i])
+          }
           ranges.refs = leftRanges
         } else {
           // requires more computation because we need to filter duplicates
           /**
-           * @type {Array<GC|Item>}
+           * @type {Array<GC|Item|Skip>}
            */
           const result = []
           let nextExpectedClock = leftRanges[0].id.clock
           /**
-           * @param {Item|GC} block
+           * @param {Item|GC|Skip} block
            */
           const addToResult = block => {
             result.push(block)
@@ -215,11 +215,11 @@ export class BlockSet {
           let li = 0
           let ri = 0
           /**
-           * @type {Item|GC|undefined}
+           * @type {Item|GC|Skip|undefined}
            */
           let lblock = leftRanges[li]
           /**
-           * @type {Item|GC|undefined}
+           * @type {Item|GC|Skip|undefined}
            */
           let rblock = rightRanges[ri]
           const applyLeft = () => {

package/src/utils/Doc.js

@@ -2,22 +2,16 @@
  * @module Y
  */
 
-import {
-  StructStore,
-  transact,
-  applyUpdate,
-  ContentDoc, Item, Transaction, // eslint-disable-line
-  encodeStateAsUpdate
-} from '../internals.js'
-
-import { YType } from '../ytype.js'
 import { ObservableV2 } from 'lib0/observable'
 import * as random from 'lib0/random'
 import * as map from 'lib0/map'
 import * as array from 'lib0/array'
 import * as promise from 'lib0/promise'
 
-export const generateNewClientId = random.uint32
+import { StructStore } from './StructStore.js'
+import { transact, generateNewClientId } from './Transaction.js'
+import { YType } from '../ytype.js'
+import { $ydoc } from './schemas.js'
 
 /**
  * @typedef {Object} DocOpts
@@ -179,12 +173,11 @@ export class Doc extends ObservableV2 {
    * @template T
    * @param {function(Transaction):T} f The function that should be executed as a transaction
    * @param {any} [origin] Origin of who started the transaction. Will be stored on transaction.origin
+   * @param {boolean} [local]
    * @return T
-   *
-   * @public
    */
-  transact (f, origin = null) {
-    return transact(this, f, origin)
+  transact (f, origin = null, local = true) {
+    return transact(this, f, origin, local)
   }
 
   /**
@@ -238,29 +231,22 @@ export class Doc extends ObservableV2 {
     if (item !== null) {
       this._item = null
       const content = /** @type {ContentDoc} */ (item.content)
-      content.doc = new Doc({ guid: this.guid, ...content.opts, shouldLoad: false })
-      content.doc._item = item
+      /**
+       * new content doc which replaces the new one
+       */
+      const contentDoc = new Doc({ guid: this.guid, ...content.opts, shouldLoad: false })
+      content.doc = contentDoc
+      contentDoc._item = item
       transact(/** @type {any} */ (item).parent.doc, transaction => {
-        const doc = content.doc
         if (!item.deleted) {
-          transaction.subdocsAdded.add(doc)
+          transaction.subdocsAdded.add(contentDoc)
         }
         transaction.subdocsRemoved.add(this)
       }, null, true)
     }
-    // @ts-ignore
-    this.emit('destroyed', [true]) // DEPRECATED!
     this.emit('destroy', [this])
     super.destroy()
   }
 }
 
-/**
- * @param {Doc} ydoc
- * @param {DocOpts} [opts]
- */
-export const cloneDoc = (ydoc, opts) => {
-  const clone = new Doc(opts)
-  applyUpdate(clone, encodeStateAsUpdate(ydoc))
-  return clone
-}
+Doc.prototype.$type = $ydoc

package/src/utils/ID.js

@@ -1,5 +1,3 @@
-import { YType } from '../internals.js' // eslint-disable-line
-
 import * as decoding from 'lib0/decoding'
 import * as encoding from 'lib0/encoding'
 import * as error from 'lib0/error'

package/src/utils/RelativePosition.js

@@ -1,21 +1,11 @@
-import {
-  writeID,
-  readID,
-  compareIDs,
-  getState,
-  findRootTypeKey,
-  Item,
-  createID,
-  ContentType,
-  followRedone,
-  getItem,
-  StructStore, ID, Doc, YType, noAttributionsManager, // eslint-disable-line
-} from '../internals.js'
-
 import * as encoding from 'lib0/encoding'
 import * as decoding from 'lib0/decoding'
 import * as error from 'lib0/error'
 
+import { Item, followRedone, ContentType } from '../structs/Item.js'
+import { writeID, readID, compareIDs, findRootTypeKey, createID } from './ID.js'
+import { baseRenderer } from './renderer-helpers.js'
+
 /**
  * A relative position is based on the Yjs model and is not affected by document changes.
  * E.g. If you place a relative position before a certain character, it will always point to this character.
@@ -156,12 +146,12 @@ export const createRelativePosition = (type, item, assoc) => {
  * @param {YType} type The base type (e.g. YText or YArray).
  * @param {number} index The absolute position.
  * @param {number} [assoc]
- * @param {import('../utils/AttributionManager.js').AbstractAttributionManager} attributionManager
+ * @param {import('../utils/Renderer.js').AbstractRenderer} renderer
  * @return {RelativePosition}
  *
  * @function
  */
-export const createRelativePositionFromTypeIndex = (type, index, assoc = 0, attributionManager = noAttributionsManager) => {
+export const createRelativePositionFromTypeIndex = (type, index, assoc = 0, renderer = baseRenderer) => {
   let t = type._start
   if (assoc < 0) {
     // associated to the left character or the beginning of a type, increment index if possible.
@@ -171,7 +161,7 @@ export const createRelativePositionFromTypeIndex = (type, index, assoc = 0, attr
     index--
   }
   while (t !== null) {
-    const len = attributionManager.contentLength(t)
+    const len = renderer.contentLength(t)
     if (len > index) {
       // case 1: found position somewhere in the linked list
       return createRelativePosition(type, createID(t.id.client, t.id.clock + index), assoc)
@@ -261,7 +251,7 @@ export const decodeRelativePosition = uint8Array => readRelativePosition(decodin
  * @param {ID} id
  */
 const getItemWithOffset = (store, id) => {
-  const item = getItem(store, id)
+  const item = store.getItem(id)
   const diff = id.clock - item.id.clock
   return {
     item, diff
@@ -282,12 +272,12 @@ const getItemWithOffset = (store, id) => {
  * @param {RelativePosition} rpos
  * @param {Doc} doc
  * @param {boolean} followUndoneDeletions - whether to follow undone deletions - see https://github.com/yjs/yjs/issues/638
- * @param {import('../utils/AttributionManager.js').AbstractAttributionManager} attributionManager
+ * @param {import('../utils/Renderer.js').AbstractRenderer} renderer
  * @return {AbsolutePosition|null}
  *
  * @function
  */
-export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndoneDeletions = true, attributionManager = noAttributionsManager) => {
+export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndoneDeletions = true, renderer = baseRenderer) => {
   const store = doc.store
   const rightID = rpos.item
   const typeID = rpos.type
@@ -296,7 +286,7 @@ export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndo
   let type = null
   let index = 0
   if (rightID !== null) {
-    if (getState(store, rightID.client) <= rightID.clock) {
+    if (store.getClock(rightID.client) <= rightID.clock) {
       return null
     }
     const res = followUndoneDeletions ? followRedone(store, rightID) : getItemWithOffset(store, rightID)
@@ -306,10 +296,10 @@ export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndo
     }
     type = /** @type {YType<any>} */ (right.parent)
     if (type._item === null || !type._item.deleted) {
-      index = attributionManager.contentLength(right) === 0 ? 0 : (res.diff + (assoc >= 0 ? 0 : 1)) // adjust position based on left association if necessary
+      index = renderer.contentLength(right) === 0 ? 0 : (res.diff + (assoc >= 0 ? 0 : 1)) // adjust position based on left association if necessary
       let n = right.left
       while (n !== null) {
-        index += attributionManager.contentLength(n)
+        index += renderer.contentLength(n)
         n = n.left
       }
     }
@@ -317,11 +307,11 @@ export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndo
     if (tname !== null) {
       type = doc.get(tname)
     } else if (typeID !== null) {
-      if (getState(store, typeID.client) <= typeID.clock) {
+      if (store.getClock(typeID.client) <= typeID.clock) {
         // type does not exist yet
         return null
       }
-      const { item } = followUndoneDeletions ? followRedone(store, typeID) : { item: getItem(store, typeID) }
+      const { item } = followUndoneDeletions ? followRedone(store, typeID) : { item: store.getItem(typeID) }
       if (item instanceof Item && item.content instanceof ContentType) {
         type = item.content.type
       } else {