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

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@y/y",
-  "version": "14.0.0-rc.2",
+  "version": "14.0.0-rc.20",
   "description": "Shared Editing Library",
-  "types": "./dist/src/index.d.ts",
   "type": "module",
   "sideEffects": false,
   "funding": {
@@ -13,9 +12,8 @@
     "clean": "rm -rf dist",
     "test": "NODE_ENV=development node ./tests/index.js --repetition-time 50",
     "test-extensive": "node ./tests/index.js --production --repetition-time 10000",
-    "dist": "npm run clean && (tsc --skipLibCheck --noEmit false|| true)",
-    "release": "PRODUCTION=1 npm run dist && test -e dist/src/index.d.ts && np",
-    "lint": "markdownlint README.md && standard && tsc --skipLibCheck",
+    "dist": "npm run clean && PRODUCTION=1 tsc --noEmit false && test -e dist/src/index.d.ts",
+    "lint": "markdownlint README.md && standard && tsc && npx dpdm --exit-code circular:1 --warning false --tree false src/index.js",
     "debug": "npm run gentesthtml && 0serve -o test.html",
     "debug:node": "node --inspect-brk tests/index.js",
     "trace-deopt": "clear && node --trace-deopt ./tests/index.js",
@@ -27,10 +25,6 @@
       "types": "./dist/src/index.d.ts",
       "default": "./src/index.js"
     },
-    "./internals": {
-      "types": "./dist/src/internals.d.ts",
-      "default": "./src/internals.js"
-    },
     "./meta": {
       "types": "./dist/src/utils/meta.d.ts",
       "default": "./src/utils/meta.js"
@@ -43,8 +37,9 @@
   },
   "files": [
     "src",
-    "dist",
-    "tests/testHelper.js"
+    "dist/src",
+    "tests/testHelper.js",
+    "global.d.ts"
   ],
   "dictionaries": {
     "test": "tests"
@@ -76,19 +71,20 @@
   },
   "homepage": "https://docs.yjs.dev",
   "dependencies": {
-    "lib0": "^1.0.0-rc.5"
+    "lib0": "^1.0.0-rc.15"
   },
   "devDependencies": {
     "@types/node": "^22.14.1",
     "@y/protocols": "^1.0.6-rc.1",
+    "@y/y": ".",
+    "dpdm": "^4.0.1",
     "markdownlint": "^0.40.0",
-    "markdownlint-cli": "^0.45.0",
+    "markdownlint-cli": "^0.43.0",
     "standard": "^17.1.2",
-    "typescript": "^5.9.3",
-    "@y/y": "."
+    "typescript": "^5.9.3"
   },
   "engines": {
     "npm": ">=8.0.0",
-    "node": ">=16.0.0"
+    "node": ">=22.0.0"
   }
 }

package/src/index.js

@@ -1,132 +1,40 @@
+/// <reference types="../global.d.ts" />
 /** eslint-env browser */
 
-export {
-  Doc,
-  Transaction,
-  YType as Type,
-  YEvent,
-  Item,
-  AbstractStruct,
-  GC,
-  Skip,
-  ContentBinary,
-  ContentDeleted,
-  ContentDoc,
-  ContentEmbed,
-  ContentFormat,
-  ContentJSON,
-  ContentAny,
-  ContentString,
-  ContentType,
-  getTypeChildren,
-  createRelativePositionFromTypeIndex,
-  createRelativePositionFromJSON,
-  createAbsolutePositionFromRelativePosition,
-  compareRelativePositions,
-  AbsolutePosition,
-  RelativePosition,
-  ID,
-  createID,
-  compareIDs,
-  getState,
-  Snapshot,
-  createSnapshot,
-  cleanupYTextFormatting,
-  snapshot,
-  emptySnapshot,
-  findRootTypeKey,
-  findIndexSS,
-  getItem,
-  getItemCleanStart,
-  getItemCleanEnd,
-  typeMapGetSnapshot,
-  typeMapGetAllSnapshot,
-  createDocFromSnapshot,
-  applyUpdate,
-  applyUpdateV2,
-  readUpdate,
-  readUpdateV2,
-  encodeStateAsUpdate,
-  encodeStateAsUpdateV2,
-  encodeStateVector,
-  UndoManager,
-  decodeSnapshot,
-  encodeSnapshot,
-  decodeSnapshotV2,
-  encodeSnapshotV2,
-  decodeStateVector,
-  logUpdate,
-  logUpdateV2,
-  decodeUpdate,
-  decodeUpdateV2,
-  relativePositionToJSON,
-  isParentOf,
-  equalSnapshots,
-  tryGc,
-  transact,
-  logType,
-  mergeUpdates,
-  mergeUpdatesV2,
-  encodeStateVectorFromUpdate,
-  encodeStateVectorFromUpdateV2,
-  encodeRelativePosition,
-  decodeRelativePosition,
-  diffUpdate,
-  diffUpdateV2,
-  convertUpdateFormatV1ToV2,
-  convertUpdateFormatV2ToV1,
-  obfuscateUpdate,
-  obfuscateUpdateV2,
-  UpdateEncoderV1,
-  UpdateEncoderV2,
-  UpdateDecoderV1,
-  UpdateDecoderV2,
-  snapshotContainsUpdate,
-  // idset
-  IdSet,
-  equalIdSets,
-  createDeleteSetFromStructStore,
-  IdMap,
-  createIdMap,
-  createContentAttribute,
-  createInsertSetFromStructStore,
-  diffIdMap,
-  diffIdSet,
-  ContentAttribute,
-  encodeIdMap,
-  createIdMapFromIdSet,
-  TwosetAttributionManager,
-  noAttributionsManager,
-  AbstractAttributionManager,
-  iterateStructsByIdSet,
-  createAttributionManagerFromDiff,
-  DiffAttributionManager,
-  createAttributionManagerFromSnapshots,
-  SnapshotAttributionManager,
-  createIdSet,
-  mergeIdSets,
-  cloneDoc,
-  createContentIdsFromUpdate,
-  createContentIdsFromUpdateV2,
-  insertIntoIdMap,
-  insertIntoIdSet,
-  mergeIdMaps,
-  readIdMap,
-  readIdSet,
-  decodeIdMap,
-  diffDocsToDelta,
-  getPathTo,
-  Attributions,
-  filterIdMap,
-  undoContentIds,
-  intersectUpdateWithContentIds,
-  intersectUpdateWithContentIdsV2,
-  createDocFromUpdate,
-  createDocFromUpdateV2
-} from './internals.js'
+// Order matters: follows internals.js ordering to avoid circular dependency issues
+
+export { IdSet, equalIdSets, createDeleteSetFromStructStore, createInsertSetFromStructStore, diffIdSet, createIdSet, mergeIdSets, insertIntoIdSet, iterateStructsByIdSet, gcIdSet, readIdSet, writeIdSet, encodeIdSet, decodeIdSet, IdMap, createIdMap, createContentAttribute, ContentAttribute, diffIdMap, encodeIdMap, createIdMapFromIdSet, createIdSetFromIdMap, insertIntoIdMap, mergeIdMaps, readIdMap, writeIdMap, decodeIdMap, filterIdMap, intersectSets, intersectMaps } from './utils/ids.js'
+export { Doc } from './utils/Doc.js'
+export { UpdateDecoderV1, UpdateDecoderV2 } from './utils/UpdateDecoder.js'
+export { UpdateEncoderV1, UpdateEncoderV2 } from './utils/UpdateEncoder.js'
+export { applyUpdate, applyUpdateV2, readUpdate, readUpdateV2, encodeStateAsUpdate, encodeStateAsUpdateV2, encodeStateVector, decodeStateVector, diffUpdate, diffUpdateV2, mergeUpdates, mergeUpdatesV2, createDocFromUpdate, createDocFromUpdateV2, cloneDoc } from './utils/encoding.js'
+export { ID, createID, compareIDs, findRootTypeKey } from './utils/ID.js'
+export { isParentOf } from './utils/isParentOf.js'
+export { logType } from './utils/logging.js'
+export { createRelativePositionFromTypeIndex, createRelativePositionFromJSON, createAbsolutePositionFromRelativePosition, compareRelativePositions, AbsolutePosition, RelativePosition, relativePositionToJSON, encodeRelativePosition, decodeRelativePosition } from './utils/RelativePosition.js'
+export { Snapshot, createSnapshot, snapshot, emptySnapshot, createDocFromSnapshot, decodeSnapshot, encodeSnapshot, decodeSnapshotV2, encodeSnapshotV2, equalSnapshots, snapshotContainsUpdate } from './utils/Snapshot.js'
+export { findIndexSS, getItemCleanStart, getItemCleanEnd, tryGc } from './utils/transaction-helpers.js'
+export { Transaction, transact, cleanupYTextFormatting } from './utils/Transaction.js'
+export { UndoManager, undoContentIds } from './utils/UndoManager.js'
+export { logUpdate, logUpdateV2, decodeUpdate, decodeUpdateV2, encodeStateVectorFromUpdate, encodeStateVectorFromUpdateV2, convertUpdateFormatV1ToV2, convertUpdateFormatV2ToV1, obfuscateUpdate, obfuscateUpdateV2, createContentIdsFromUpdate, createContentIdsFromUpdateV2, intersectUpdateWithContentIds, intersectUpdateWithContentIdsV2 } from './utils/updates.js'
+export { YEvent, getPathTo } from './utils/YEvent.js'
+export { TwosetRenderer, baseRenderer, AbstractRenderer, createDiffRenderer, DiffRenderer, createSnapshotRenderer, SnapshotRenderer, Attributions, $renderer } from './utils/Renderer.js'
+export { diffDocsToDelta } from './utils/delta-helpers.js'
+export { YType as Type, getTypeChildren, typeMapGetSnapshot, typeMapGetAllSnapshot, $ytype, $ytypeAny } from './ytype.js'
+export { AbstractStruct } from './structs/AbstractStruct.js'
+export { GC } from './structs/GC.js'
+export { Item, ContentBinary, ContentDeleted, ContentDoc, ContentEmbed, ContentFormat, ContentJSON, ContentAny, ContentString, ContentType } from './structs/Item.js'
+export { Skip } from './structs/Skip.js'
 
 export * from './utils/meta.js'
 
+/**
+ * @typedef {import('./utils/ids.js').ContentIds} ContentIds
+ */
+/**
+ * @typedef {import('./utils/ids.js').ContentMap} ContentMap
+ */
+
 const glo = /** @type {any} */ (typeof globalThis !== 'undefined'
   ? globalThis
   : typeof window !== 'undefined'

package/src/structs/AbstractStruct.js

@@ -1,7 +1,3 @@
-import {
-  UpdateEncoderV1, UpdateEncoderV2, ID, Transaction // eslint-disable-line
-} from '../internals.js'
-
 import * as error from 'lib0/error'
 
 export class AbstractStruct {
@@ -25,35 +21,44 @@ export class AbstractStruct {
    * Merge this struct with the item to the right.
    * This method is already assuming that `this.id.clock + this.length === this.id.clock`.
    * Also this method does *not* remove right from StructStore!
-   * @param {AbstractStruct} right
+   * @param {GC|Item|Skip} _right
    * @return {boolean} whether this merged with right
    */
-  mergeWith (right) {
+  mergeWith (_right) {
     return false
   }
 
   /**
-   * @param {UpdateEncoderV1 | UpdateEncoderV2} encoder The encoder to write data to.
-   * @param {number} offset
-   * @param {number} encodingRef
+   * @param {UpdateEncoderV1 | UpdateEncoderV2} _encoder The encoder to write data to.
+   * @param {number} _offset
+   * @param {number} _encodingRef
    */
-  write (encoder, offset, encodingRef) {
+  write (_encoder, _offset, _encodingRef) {
     throw error.methodUnimplemented()
   }
 
   /**
-   * @param {Transaction} transaction
-   * @param {number} offset
+   * @param {Transaction} _transaction
+   * @param {number} _offset
    */
-  integrate (transaction, offset) {
+  integrate (_transaction, _offset) {
     throw error.methodUnimplemented()
   }
 
   /**
-   * @param {number} diff
-   * @return {import('../internals.js').GC|import('../internals.js').Item}
+   * @param {number} _diff
+   * @return {GC|Item|Skip}
    */
-  splice (diff) {
+  splice (_diff) {
     throw error.methodUnimplemented()
   }
 }
+
+/**
+ * @param {IdSet} idSet
+ * @param {AbstractStruct} struct
+ *
+ * @private
+ * @function
+ */
+export const addStructToIdSet = (idSet, struct) => idSet.add(struct.id.client, struct.id.clock, struct.length)

package/src/structs/GC.js

@@ -1,11 +1,5 @@
-import {
-  AbstractStruct,
-  addStruct,
-  addStructToIdSet,
-  addToIdSet,
-  createID,
-  UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction // eslint-disable-line
-} from '../internals.js'
+import { AbstractStruct, addStructToIdSet } from './AbstractStruct.js'
+import { createID } from '../utils/ID.js'
 
 export const structGCRefNumber = 0
 
@@ -20,7 +14,7 @@ export class GC extends AbstractStruct {
   delete () {}
 
   /**
-   * @param {GC} right
+   * @param {GC | Skip | Item} right
    * @return {boolean}
    */
   mergeWith (right) {
@@ -40,9 +34,9 @@ export class GC extends AbstractStruct {
       this.id.clock += offset
       this.length -= offset
     }
-    addToIdSet(transaction.deleteSet, this.id.client, this.id.clock, this.length)
+    transaction.deleteSet.add(this.id.client, this.id.clock, this.length)
     addStructToIdSet(transaction.insertSet, this)
-    addStruct(transaction.doc.store, this)
+    transaction.doc.store.add(this)
   }
 
   /**
@@ -55,15 +49,6 @@ export class GC extends AbstractStruct {
     encoder.writeLen(this.length - offset - offsetEnd)
   }
 
-  /**
-   * @param {Transaction} _transaction
-   * @param {StructStore} _store
-   * @return {null | number}
-   */
-  getMissing (_transaction, _store) {
-    return null
-  }
-
   /**
    * gc structs can't be spliced.
    *
@@ -78,3 +63,13 @@ export class GC extends AbstractStruct {
     return other
   }
 }
+
+/**
+ * @type {0}
+ */
+GC.prototype.ref = structGCRefNumber
+
+/**
+ * @type {false}
+ */
+GC.prototype.isItem = false