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

package/src/utils/{AttributionManager.js → Renderer.js}

@@ -1,154 +1,26 @@
-import {
-  getItem,
-  diffIdSet,
-  createInsertSetFromStructStore,
-  createDeleteSetFromStructStore,
-  createIdMapFromIdSet,
-  ContentDeleted,
-  insertIntoIdMap,
-  insertIntoIdSet,
-  diffIdMap,
-  createIdMap,
-  mergeIdMaps,
-  createID,
-  mergeIdSets,
-  applyUpdate,
-  writeIdSet,
-  UpdateEncoderV1,
-  transact,
-  createMaybeAttrRange,
-  createIdSet,
-  writeStructsFromIdSet,
-  UndoManager,
-  StackItem,
-  getItemCleanStart,
-  intersectSets,
-  intersectMaps,
-  ContentFormat,
-  createContentAttribute,
-  StructStore, Transaction, ID, IdSet, Item, Snapshot, Doc, AbstractContent, IdMap, // eslint-disable-line
-  encodeStateAsUpdate
-} from '../internals.js'
-
-import * as error from 'lib0/error'
 import { ObservableV2 } from 'lib0/observable'
 import * as encoding from 'lib0/encoding'
-import * as s from 'lib0/schema'
-
-export const attributionJsonSchema = s.$object({
-  insert: s.$array(s.$string).optional,
-  insertedAt: s.$number.optional,
-  delete: s.$array(s.$string).optional,
-  deletedAt: s.$number.optional,
-  format: s.$record(s.$string, s.$array(s.$string)).optional,
-  formatAt: s.$number.optional
-})
 
-/**
- * @todo rename this to `insertBy`, `insertAt`, ..
- *
- * @typedef {s.Unwrap<typeof attributionJsonSchema>} Attribution
- */
-
-/**
- * @todo SHOULD NOT RETURN AN OBJECT!
- * @param {Array<import('./IdMap.js').ContentAttribute<any>>?} attrs
- * @param {boolean} deleted - whether the attributed item is deleted
- * @return {Attribution?}
- */
-export const createAttributionFromAttributionItems = (attrs, deleted) => {
-  if (attrs == null) {
-    return null
-  }
-  /**
-   * @type {Attribution}
-   */
-  const attribution = {}
-  if (deleted) {
-    attribution.delete = []
-  } else {
-    attribution.insert = []
-  }
-  attrs.forEach(attr => {
-    switch (attr.name) {
-      // eslint-disable-next-line no-fallthrough
-      case 'insert':
-      case 'delete': {
-        // needs to be non-ambiguous: don't add existing attr if it doesn't match the actual status
-        attribution[attr.name]?.push(attr.val)
-        break
-      }
-      default: {
-        if (attr.name[0] !== '_') {
-          /** @type {any} */ (attribution)[attr.name] = attr.val
-        }
-      }
-    }
-  })
-  return attribution
-}
+import { getItemCleanStart } from './transaction-helpers.js'
+import { diffIdSet, createInsertSetFromStructStore, createDeleteSetFromStructStore, insertIntoIdSet, mergeIdSets, intersectSets, createIdSet, writeIdSet, createIdMapFromIdSet, insertIntoIdMap, diffIdMap, createIdMap, mergeIdMaps, intersectMaps, createMaybeAttrRange, createContentAttribute } from './ids.js'
+import { ContentDeleted, ContentFormat } from '../structs/Item.js'
+import { createID } from './ID.js'
+import { writeStructsFromIdSet } from './encoding-helpers.js'
+import { applyUpdate, encodeStateAsUpdate } from './encoding.js'
+import { UpdateEncoderV1 } from './UpdateEncoder.js'
+import { transact } from './Transaction.js'
+import { UndoManager, StackItem } from './UndoManager.js'
 
-/**
- * @template T
- */
-export class AttributedContent {
-  /**
-   * @param {AbstractContent} content
-   * @param {number} clock
-   * @param {boolean} deleted
-   * @param {Array<import('./IdMap.js').ContentAttribute<T>> | null} attrs
-   * @param {0|1|2} renderBehavior
-   */
-  constructor (content, clock, deleted, attrs, renderBehavior) {
-    this.content = content
-    this.clock = clock
-    this.deleted = deleted
-    this.attrs = attrs
-    this.render = renderBehavior === 0 ? false : (renderBehavior === 1 ? (!deleted || attrs != null) : true)
-  }
-}
-
-/**
- * Abstract class for associating Attributions to content / changes
- *
- * Should fire an event when the attributions changed _after_ the original change happens. This
- * Event will be used to update the attribution on the current content.
- *
- * @extends {ObservableV2<{change:(idset:IdSet,origin:any,local:boolean)=>void}>}
- */
-export class AbstractAttributionManager extends ObservableV2 {
-  /**
-   * @param {Array<AttributedContent<any>>} _contents - where to write the result
-   * @param {number} _client
-   * @param {number} _clock
-   * @param {boolean} _deleted
-   * @param {AbstractContent} _content
-   * @param {0|1|2} _shouldRender - 0: if undeleted or attributed, render as a retain operation. 1: render only if undeleted or attributed. 2: render as insert operation (if unattributed and deleted, render as delete).
-   */
-  readContent (_contents, _client, _clock, _deleted, _content, _shouldRender) {
-    error.methodUnimplemented()
-  }
+import { $renderer, AttributedContent } from './renderer-helpers.js'
 
-  /**
-   * Calculate the length of the attributed content. This is used by iterators that walk through the
-   * content.
-   *
-   * If the content is not countable, it should return 0.
-   *
-   * @param {Item} _item
-   * @return {number}
-   */
-  contentLength (_item) {
-    error.methodUnimplemented()
-  }
-}
+export { baseRenderer, BaseRenderer, AbstractRenderer, $renderer } from './renderer-helpers.js'
 
 /**
- * @implements AbstractAttributionManager
+ * @implements AbstractRenderer
  *
  * @extends {ObservableV2<{change:(idset:IdSet,origin:any,local:boolean)=>void}>}
  */
-export class TwosetAttributionManager extends ObservableV2 {
+export class TwosetRenderer extends ObservableV2 {
   /**
    * @param {IdMap<any>} inserts
    * @param {IdMap<any>} deletes
@@ -159,6 +31,8 @@ export class TwosetAttributionManager extends ObservableV2 {
     this.deletes = deletes
   }
 
+  get $type () { return $renderer }
+
   /**
    * @param {Array<AttributedContent<any>>} contents - where to write the result
    * @param {number} client
@@ -196,39 +70,6 @@ export class TwosetAttributionManager extends ObservableV2 {
   }
 }
 
-/**
- * Abstract class for associating Attributions to content / changes
- *
- * @implements AbstractAttributionManager
- *
- * @extends {ObservableV2<{change:(idset:IdSet,origin:any,local:boolean)=>void}>}
- */
-export class NoAttributionsManager extends ObservableV2 {
-  /**
-   * @param {Array<AttributedContent<any>>} contents - where to write the result
-   * @param {number} _client
-   * @param {number} clock
-   * @param {boolean} deleted
-   * @param {AbstractContent} content
-   * @param {0|1|2} shouldRender - whether this should render or just result in a `retain` operation
-   */
-  readContent (contents, _client, clock, deleted, content, shouldRender) {
-    if (!deleted || shouldRender) {
-      contents.push(new AttributedContent(content, clock, deleted, null, shouldRender))
-    }
-  }
-
-  /**
-   * @param {Item} item
-   * @return {number}
-   */
-  contentLength (item) {
-    return (item.deleted || !item.content.isCountable()) ? 0 : item.length
-  }
-}
-
-export const noAttributionsManager = new NoAttributionsManager()
-
 /**
  * @param {StructStore} store
  * @param {number} client
@@ -237,7 +78,7 @@ export const noAttributionsManager = new NoAttributionsManager()
  */
 const getItemContent = (store, client, clock, len) => {
   // Retrieved item is never more fragmented than the newer item.
-  const prevItem = getItem(store, createID(client, clock))
+  const prevItem = store.getItem(createID(client, clock))
   const diffStart = clock - prevItem.id.clock
   let content = prevItem.length > 1 ? prevItem.content.copy() : prevItem.content
   // trim itemContent to the correct size.
@@ -252,15 +93,15 @@ const getItemContent = (store, client, clock, len) => {
 
 /**
  * @param {Transaction?} tr - only specify this if you want to fill the content of deleted content
- * @param {DiffAttributionManager} am
+ * @param {DiffRenderer} renderer
  * @param {ID} start
  * @param {ID} end
  * @param {boolean} collectAll - collect as many items as possible. Accept adding redundant changes.
  */
-const collectSuggestedChanges = (tr, am, start, end, collectAll) => {
+const collectSuggestedChanges = (tr, renderer, start, end, collectAll) => {
   const inserts = createIdSet()
   const deletes = createIdSet()
-  const store = am._nextDoc.store
+  const store = renderer._nextDoc.store
   /**
    * make sure to collect suggestions until all formats are closed
    * @type {Set<string>}
@@ -269,8 +110,8 @@ const collectSuggestedChanges = (tr, am, start, end, collectAll) => {
   /**
    * @type {Item?}
    */
-  let item = getItem(store, start)
-  const endItem = start === end ? item : (end == null ? null : getItem(store, end))
+  let item = store.getItem(start)
+  const endItem = start === end ? item : (end == null ? null : store.getItem(end))
 
   // walk to the left and find first un-attributed change that is rendered
   while (item.left != null) {
@@ -280,7 +121,7 @@ const collectSuggestedChanges = (tr, am, start, end, collectAll) => {
       break
     }
     if (!item.deleted) {
-      const slice = am.inserts.slice(item.id.client, item.id.clock, item.length)
+      const slice = renderer.inserts.slice(item.id.client, item.id.clock, item.length)
       if (slice.some(s => s.attrs === null)) {
         for (let i = slice.length - 1; i >= 0; i--) {
           const s = slice[i]
@@ -296,7 +137,7 @@ const collectSuggestedChanges = (tr, am, start, end, collectAll) => {
   // eslint-disable-next-line
   itemLoop: while (item != null) {
     const itemClient = item.id.client
-    const slice = (item.deleted ? am.deletes : am.inserts).slice(itemClient, item.id.clock, item.length)
+    const slice = (item.deleted ? renderer.deletes : renderer.inserts).slice(itemClient, item.id.clock, item.length)
     foundEndItem ||= item === endItem
     if (item.deleted) {
       // item probably gc'd content. Need to split item and fill with content again
@@ -313,7 +154,7 @@ const collectSuggestedChanges = (tr, am, start, end, collectAll) => {
         if (tr != null) {
           const splicedItem = getItemCleanStart(tr, createID(itemClient, s.clock))
           if (s.attrs != null) {
-            splicedItem.content = getItemContent(am._prevDocStore, itemClient, s.clock, s.len)
+            splicedItem.content = getItemContent(renderer._prevDocStore, itemClient, s.clock, s.len)
           }
         }
       }
@@ -356,15 +197,15 @@ export class Attributions {
 const extractAttributions = (attrs, slice) => attrs == null ? createIdMapFromIdSet(slice, []) : mergeIdMaps([intersectMaps(attrs, slice), createIdMapFromIdSet(slice, [])])
 
 /**
- * @implements AbstractAttributionManager
+ * @implements AbstractRenderer
  *
  * @extends {ObservableV2<{change:(idset:IdSet,origin:any,local:boolean)=>void}>}
  */
-export class DiffAttributionManager extends ObservableV2 {
+export class DiffRenderer extends ObservableV2 {
   /**
    * @param {Doc} prevDoc
    * @param {Doc} nextDoc
-   * @param {Object} [options] - options for the attribution manager
+   * @param {Object} [options] - options for the renderer
    * @param {Attributions?} [options.attrs] - the attributes to apply to the diff
    */
   constructor (prevDoc, nextDoc, { attrs = null } = {}) {
@@ -423,7 +264,7 @@ export class DiffAttributionManager extends ObservableV2 {
     })
     this._afterTrListener = nextDoc.on('afterTransaction', (tr) => {
       // apply deletes on attributed deletes (content that is already deleted, but is rendered by
-      // the attribution manager)
+      // the renderer)
       if (!this.suggestionMode && tr.local && (this.suggestionOrigins == null || this.suggestionOrigins.some(o => o === tr.origin))) {
         const attributedDeletes = tr.meta.get('attributedDeletes')
         if (attributedDeletes != null) {
@@ -449,6 +290,8 @@ export class DiffAttributionManager extends ObservableV2 {
     prevDoc.on('destroy', this._destroyHandler)
   }
 
+  get $type () { return $renderer }
+
   destroy () {
     super.destroy()
     this._nextDoc.off('destroy', this._destroyHandler)
@@ -525,7 +368,7 @@ export class DiffAttributionManager extends ObservableV2 {
           continue
         }
         // Retrieved item is never more fragmented than the newer item.
-        const prevItem = getItem(this._prevDocStore, createID(client, s.clock))
+        const prevItem = this._prevDocStore.getItem(createID(client, s.clock))
         const diffStart = s.clock - prevItem.id.clock
         content = prevItem.length > 1 ? prevItem.content.copy() : prevItem.content
         // trim itemContent to the correct size.
@@ -568,25 +411,25 @@ export class DiffAttributionManager extends ObservableV2 {
  *
  * @param {Doc} prevDoc
  * @param {Doc} nextDoc
- * @param {Object} [options] - options for the attribution manager
- * @param {import('./meta.js').ContentMap?} [options.attrs] - the attributes to apply to the diff
+ * @param {Object} [options] - options for the renderer
+ * @param {ContentMap?} [options.attrs] - the attributes to apply to the diff
  */
-export const createAttributionManagerFromDiff = (prevDoc, nextDoc, options) => new DiffAttributionManager(prevDoc, nextDoc, options)
+export const createDiffRenderer = (prevDoc, nextDoc, options) => new DiffRenderer(prevDoc, nextDoc, options)
 
 /**
- * Intended for projects that used the v13 snapshot feature. With this AttributionManager you can
+ * Intended for projects that used the v13 snapshot feature. With this renderer you can
  * read content similar to the previous snapshot api. Requires that `ydoc.gc` is turned off.
  *
- * @implements AbstractAttributionManager
+ * @implements AbstractRenderer
  *
  * @extends {ObservableV2<{change:(idset:IdSet,origin:any,local:boolean)=>void}>}
  */
-export class SnapshotAttributionManager extends ObservableV2 {
+export class SnapshotRenderer extends ObservableV2 {
   /**
    * @param {Snapshot} prevSnapshot
    * @param {Snapshot} nextSnapshot
-   * @param {Object} [options] - options for the attribution manager
-   * @param {Array<import('./IdMap.js').ContentAttribute<any>>} [options.attrs] - the attributes to apply to the diff
+   * @param {Object} [options] - options for the renderer
+   * @param {Array<ContentAttribute>} [options.attrs] - the attributes to apply to the diff
    */
   constructor (prevSnapshot, nextSnapshot) {
     super()
@@ -602,6 +445,8 @@ export class SnapshotAttributionManager extends ObservableV2 {
     this.attrs = mergeIdMaps([diffIdMap(inserts, prevSnapshot.ds), deletes])
   }
 
+  get $type () { return $renderer }
+
   /**
    * @param {Array<AttributedContent<any>>} contents - where to write the result
    * @param {number} client
@@ -650,4 +495,4 @@ export class SnapshotAttributionManager extends ObservableV2 {
  * @param {Snapshot} prevSnapshot
  * @param {Snapshot} nextSnapshot
  */
-export const createAttributionManagerFromSnapshots = (prevSnapshot, nextSnapshot = prevSnapshot) => new SnapshotAttributionManager(prevSnapshot, nextSnapshot)
+export const createSnapshotRenderer = (prevSnapshot, nextSnapshot = prevSnapshot) => new SnapshotRenderer(prevSnapshot, nextSnapshot)

package/src/utils/Snapshot.js

@@ -1,29 +1,18 @@
-import {
-  createDeleteSetFromStructStore,
-  getStateVector,
-  getItemCleanStart,
-  iterateStructsByIdSet,
-  writeIdSet,
-  writeStateVector,
-  readIdSet,
-  readStateVector,
-  createIdSet,
-  createID,
-  getState,
-  findIndexSS,
-  UpdateEncoderV2,
-  applyUpdateV2,
-  LazyStructReader,
-  equalIdSets,
-  UpdateDecoderV1, UpdateDecoderV2, IdSetEncoderV1, IdSetEncoderV2, IdSetDecoderV1, IdSetDecoderV2, Transaction, Doc, IdSet, Item, // eslint-disable-line
-  mergeIdSets
-} from '../internals.js'
-
 import * as map from 'lib0/map'
 import * as set from 'lib0/set'
 import * as decoding from 'lib0/decoding'
 import * as encoding from 'lib0/encoding'
 
+import { createID } from './ID.js'
+import { createDeleteSetFromStructStore, createIdSet, iterateStructsByIdSet, equalIdSets, mergeIdSets, writeIdSet, readIdSet } from './ids.js'
+import { getStateVector } from './StructStore.js'
+import { findIndexSS, getItemCleanStart } from './transaction-helpers.js'
+import { writeStateVector, readStateVector, applyUpdateV2 } from './encoding.js'
+import { UpdateDecoderV1, UpdateDecoderV2, IdSetDecoderV1, IdSetDecoderV2 } from './UpdateDecoder.js'
+import { UpdateEncoderV2, IdSetEncoderV1, IdSetEncoderV2 } from './UpdateEncoder.js'
+import { LazyStructReader } from './updates.js'
+import { Doc } from './Doc.js'
+
 export class Snapshot {
   /**
    * @param {IdSet} ds
@@ -108,17 +97,6 @@ export const emptySnapshot = createSnapshot(createIdSet(), new Map())
  */
 export const snapshot = doc => createSnapshot(createDeleteSetFromStructStore(doc.store), getStateVector(doc.store))
 
-/**
- * @param {Item} item
- * @param {Snapshot|undefined} snapshot
- *
- * @protected
- * @function
- */
-export const isVisible = (item, snapshot) => snapshot === undefined
-  ? !item.deleted
-  : snapshot.sv.has(item.id.client) && (snapshot.sv.get(item.id.client) || 0) > item.id.clock && !snapshot.ds.hasId(item.id)
-
 /**
  * @param {Transaction} transaction
  * @param {Snapshot} snapshot
@@ -129,7 +107,7 @@ export const splitSnapshotAffectedStructs = (transaction, snapshot) => {
   // check if we already split for this snapshot
   if (!meta.has(snapshot)) {
     snapshot.sv.forEach((clock, client) => {
-      if (clock < getState(store, client)) {
+      if (clock < store.getClock(client)) {
         getItemCleanStart(transaction, createID(client, clock))
       }
     })
@@ -141,11 +119,11 @@ export const splitSnapshotAffectedStructs = (transaction, snapshot) => {
 /**
  * @example
  *  const ydoc = new Y.Doc({ gc: false })
- *  ydoc.getText().insert(0, 'world!')
+ *  ydoc.get().insert(0, 'world!')
  *  const snapshot = Y.snapshot(ydoc)
- *  ydoc.getText().insert(0, 'hello ')
+ *  ydoc.get().insert(0, 'hello ')
  *  const restored = Y.createDocFromSnapshot(ydoc, snapshot)
- *  assert(restored.getText().toString() === 'world!')
+ *  assert(restored.get().toString() === 'world!')
  *
  * @param {Doc} originDoc
  * @param {Snapshot} snapshot
@@ -173,7 +151,7 @@ export const createDocFromSnapshot = (originDoc, snapshot, newDoc = new Doc()) =
       if (clock === 0) {
         continue
       }
-      if (clock < getState(originDoc.store, client)) {
+      if (clock < originDoc.store.getClock(client)) {
         getItemCleanStart(transaction, createID(client, clock))
       }
       const structs = originDoc.store.clients.get(client) || []