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

package/README.md

@@ -50,7 +50,6 @@ Showcase](https://yjs-diagram.synergy.codes/).
 
 * [AFFiNE](https://affine.pro/) A local-first, privacy-first, open source
   knowledge base. :star2:
-* [Huly](https://huly.io/) - Open Source All-in-One Project Management Platform :star2:
 * [Cargo](https://cargo.site/) Site builder for designers and artists :star2:
 * [Gitbook](https://gitbook.com) Knowledge management for technical teams :star2:
 * [Evernote](https://evernote.com) Note-taking app :star2:
@@ -62,6 +61,7 @@ Showcase](https://yjs-diagram.synergy.codes/).
 * [Dynaboard](https://dynaboard.com/) Build web apps collaboratively. :star:
 * [Relm](https://www.relm.us/) A collaborative gameworld for teamwork and
   community. :star:
+* [Huly](https://huly.io/) - Open Source All-in-One Project Management Platform
 * [Room.sh](https://room.sh/) A meeting application with integrated
   collaborative drawing, editing, and coding tools. :star:
 * [Nimbus Note](https://nimbusweb.me/note.php) A note-taking app designed by
@@ -131,6 +131,8 @@ editing for your IDE or custom editor
 * [ProtonMail | Proton Docs](https://proton.me/drive/docs) - E2E encrypted
   collaborative documents in Proton Drive.
 * [Theneo](https://www.theneo.io/) - AI-powered API docs with live team collaboration.
+* [ToolJet](https://tooljet.com/) - Build full-stack enterprise internal apps in
+  minutes.
 
 ## Table of Contents
 
@@ -157,8 +159,8 @@ are implemented in separate modules.
 
 ### Bindings
 
-| Name | Cursors | Binding |  Demo |
-|---|:-:|---|---|
+| Name | Cursors | Binding | Demo |
+| --- | :-: | --- | --- |
 | [ProseMirror](https://prosemirror.net/)                                                   | ✔ | [y-prosemirror](https://github.com/yjs/y-prosemirror) | [demo](https://demos.yjs.dev/prosemirror/prosemirror.html) |
 | [Quill](https://quilljs.com/) | ✔ | [y-quill](https://github.com/yjs/y-quill) | [demo](https://demos.yjs.dev/quill/quill.html) |
 | [CodeMirror](https://codemirror.net/) | ✔ | [y-codemirror](https://github.com/yjs/y-codemirror) | [demo](https://demos.yjs.dev/codemirror/codemirror.html) |
@@ -171,12 +173,13 @@ are implemented in separate modules.
 | [Tiptap](https://tiptap.dev/) | ✔ | [y-prosemirror](https://github.com/yjs/y-prosemirror) | [demo](https://template.tiptap.dev/preview/templates/simple) |
 | [Milkdown](https://github.com/Milkdown/milkdown) | ✔ | [y-prosemirror](https://github.com/yjs/y-prosemirror) | [demo](https://milkdown.dev/playground) |
 | [Superdoc](https://superdoc.dev/) | ✔ | (native) | [demo](https://superdoc.dev/) |
-| [valtio](https://github.com/pmndrs/valtio) |  | [valtio-yjs](https://github.com/dai-shi/valtio-yjs) | [demo](https://codesandbox.io/s/valtio-yjs-demo-ox3iy) |
-| [immer](https://github.com/immerjs/immer) |  | [immer-yjs](https://github.com/sep2/immer-yjs) | [demo](https://codesandbox.io/s/immer-yjs-demo-6e0znb) |
+| [valtio](https://github.com/pmndrs/valtio) | | [valtio-yjs](https://github.com/dai-shi/valtio-yjs) | [demo](https://codesandbox.io/s/valtio-yjs-demo-ox3iy) |
+| [immer](https://github.com/immerjs/immer) | | [immer-yjs](https://github.com/sep2/immer-yjs) | [demo](https://codesandbox.io/s/immer-yjs-demo-6e0znb) |
+| [mutative](https://github.com/unadlib/mutative) | | [mutative-yjs](https://github.com/mutativejs/mutative-yjs) | [demo](https://codesandbox.io/p/sandbox/fjrwk3) |
 | React | | [react-yjs](https://github.com/nikgraf/react-yjs) | [demo](https://react-yjs-example.vercel.app/) |
 | React / Vue / Svelte / MobX | | [SyncedStore](https://syncedstore.org) | [demo](https://syncedstore.org/docs/react) |
-| [mobx-keystone](https://mobx-keystone.js.org/) |  | [mobx-keystone-yjs](https://github.com/xaviergonz/mobx-keystone/tree/master/packages/mobx-keystone-yjs) | [demo](https://mobx-keystone.js.org/examples/yjs-binding) |
-| [PSPDFKit](https://www.nutrient.io/) |  | [yjs-pspdfkit](https://github.com/hoangqwe159/yjs-pspdfkit) | [demo](https://github.com/hoangqwe159/yjs-pspdfkit) |
+| [mobx-keystone](https://mobx-keystone.js.org/) | | [mobx-keystone-yjs](https://github.com/xaviergonz/mobx-keystone/tree/master/packages/mobx-keystone-yjs) | [demo](https://mobx-keystone.js.org/examples/yjs-binding) |
+| [PSPDFKit](https://www.nutrient.io/) | | [yjs-pspdfkit](https://github.com/hoangqwe159/yjs-pspdfkit) | [demo](https://github.com/hoangqwe159/yjs-pspdfkit) |
 | [Rows n'Columns](https://www.rowsncolumns.app/) | ✔ | [@rowsncolumns/y-spreadsheet](https://docs.rowsncolumns.app/collaboration/yjs-collaboration) | |
 
 ### Utilities
@@ -190,7 +193,7 @@ Library with <code>YMultiDocUndoManager</code> (undo/redo across Yjs docs) and
 <code>YKeyValue</code> (optimized key-value store).
   </dd>
   <dt>
-<a href="https://github.com/Tulip-Writer/yjs-orderedtree"> yjs-orderedtree </a> 🌳
+<a href="https://github.com/Tulip-Writer/yjs-orderedtree">yjs-orderedtree</a> 🌳
   </dt>
   <dd>
 Class for ordered trees via Y.Map. Handles <code>insert</code>,
@@ -304,6 +307,13 @@ Encryption (E2EE).
   <dd>
 An ActionCable companion for Yjs clients. There is a fitting
 <a href="https://github.com/y-crdt/yrb-redis">redis extension</a> as well.
+  </dd>
+  <dt><a href="https://github.com/uwx/y-atproto">y-atproto</a></dt>
+  <dd>
+A Yjs provider that syncs documents over the
+<a href="https://atproto.com/">AT Protocol</a> (the decentralized protocol
+behind Bluesky). Documents are stored as ATProto records and real-time updates
+are delivered via <a href="https://github.com/bluesky-social/jetstream">Jetstream</a>.
   </dd>
   <dt><a href="https://github.com/y-crdt/ypy-websocket">ypy-websocket</a></dt>
   <dd>
@@ -391,13 +401,18 @@ There are several Yjs-compatible ports to other programming languages.
 * [y-crdt](https://github.com/y-crdt/y-crdt) - Rust implementation with multiple
 language bindings to other languages
   * [yrs](https://github.com/y-crdt/y-crdt/tree/main/yrs) - Rust interface
-  * [ypy](https://github.com/y-crdt/ypy) - Python binding
+  * [pycrdt](https://github.com/y-crdt/pycrdt) - Python binding
   * [yrb](https://github.com/y-crdt/yrb) - Ruby binding
+  * [yr](https://github.com/y-crdt/yr) - R binding
+  * [ydotnet](https://github.com/y-crdt/ydotnet) - .NET/C# binding
   * [yswift](https://github.com/y-crdt/yswift) - Swift binding
+  * [ykt](https://github.com/y-crdt/ykt) - Kotlin binding
   * [yffi](https://github.com/y-crdt/y-crdt/tree/main/yffi) - C-FFI
   * [ywasm](https://github.com/y-crdt/y-crdt/tree/main/ywasm) - WASM binding
-  * [y_ex](https://github.com/satoren/y_ex) - Elixir bindings
+  * [y_ex](https://github.com/satoren/y_ex) - Elixir binding
+  * [ypy](https://github.com/y-crdt/ypy) - Python binding (deprecated, use pycrdt)
 * [ycs](https://github.com/yjs/ycs) - .Net compatible C# implementation.
+* [ygo](https://github.com/reearth/ygo) - Go implementation.
 
 ## Getting Started
 
@@ -559,7 +574,8 @@ to JSON using their <code>toJSON</code> method.
     </dd>
     <b><code>[Symbol.Iterator]</code></b>
     <dd>
-      Returns an YArray Iterator that contains the values for each index in the array.
+      Returns an YArray Iterator that contains the values for each index in
+      the array.
       <pre>for (let value of yarray) { .. }</pre>
     </dd>
     <b><code>observe(function(YArrayEvent, Transaction):void)</code></b>
@@ -1189,8 +1205,16 @@ ytext.toString() // => 'abc'
 
 <dl>
   <b><code>constructor(scope:Y.AbstractType|Array&lt;Y.AbstractType&gt;
-  [, {captureTimeout:number,trackedOrigins:Set&lt;any&gt;,deleteFilter:function(item):boolean}])</code></b>
+  [, {captureTimeout:number,trackedOrigins:Set&lt;any&gt;,deleteFilter:function(item):boolean,ignoreRemoteAttributeChanges:boolean}])</code></b>
   <dd>Accepts either single type as scope or an array of types.</dd>
+  <b><code>ignoreRemoteAttributeChanges:boolean</code></b>
+  <dd>
+By default, the UndoManager will never overwrite remote changes. In some cases
+this is not the expected behavior. When set to <code>true</code>, undo/redo may
+overwrite remote attribute changes (e.g. on <code>Y.Map</code> keys or
+<code>Y.XmlElement</code> / <code>Y.XmlText</code> attributes). Defaults to
+<code>false</code>. <em>(previously named <code>ignoreRemoteMapChanges</code>)</em>
+  </dd>
   <b><code>undo()</code></b>
   <dd></dd>
   <b><code>redo()</code></b>

package/dist/src/index.d.ts

@@ -1,3 +1,26 @@
+export { Doc } from "./utils/Doc.js";
+export { isParentOf } from "./utils/isParentOf.js";
+export { logType } from "./utils/logging.js";
+export { diffDocsToDelta } from "./utils/delta-helpers.js";
+export { AbstractStruct } from "./structs/AbstractStruct.js";
+export { GC } from "./structs/GC.js";
+export { Skip } from "./structs/Skip.js";
 export * from "./utils/meta.js";
-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, 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";
+export type ContentIds = import("./utils/ids.js").ContentIds;
+export type ContentMap = import("./utils/ids.js").ContentMap;
+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 { 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 { 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 { YType as Type, getTypeChildren, typeMapGetSnapshot, typeMapGetAllSnapshot, $ytype, $ytypeAny } from "./ytype.js";
+export { Item, ContentBinary, ContentDeleted, ContentDoc, ContentEmbed, ContentFormat, ContentJSON, ContentAny, ContentString, ContentType } from "./structs/Item.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;yBA+Ba,OAAO,gBAAgB,EAAE,UAAU;yBAGnC,OAAO,gBAAgB,EAAE,UAAU"}

package/dist/src/structs/AbstractStruct.d.ts

@@ -4,7 +4,7 @@ export class AbstractStruct {
      * @param {number} length
      */
     constructor(id: ID, length: number);
-    id: ID;
+    id: import("../index.js").ID;
     length: number;
     /**
      * @type {boolean}
@@ -14,29 +14,26 @@ 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: AbstractStruct): boolean;
+    mergeWith(_right: GC | Item | Skip): boolean;
     /**
-     * @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: UpdateEncoderV1 | UpdateEncoderV2, offset: number, encodingRef: number): void;
+    write(_encoder: UpdateEncoderV1 | UpdateEncoderV2, _offset: number, _encodingRef: number): void;
     /**
-     * @param {Transaction} transaction
-     * @param {number} offset
+     * @param {Transaction} _transaction
+     * @param {number} _offset
      */
-    integrate(transaction: Transaction, offset: number): void;
+    integrate(_transaction: Transaction, _offset: number): void;
     /**
-     * @param {number} diff
-     * @return {import('../internals.js').GC|import('../internals.js').Item}
+     * @param {number} _diff
+     * @return {GC|Item|Skip}
      */
-    splice(diff: number): import("../internals.js").GC | import("../internals.js").Item;
+    splice(_diff: number): GC | Item | Skip;
 }
-import { ID } from '../internals.js';
-import { UpdateEncoderV1 } from '../internals.js';
-import { UpdateEncoderV2 } from '../internals.js';
-import { Transaction } from '../internals.js';
+export function addStructToIdSet(idSet: IdSet, struct: AbstractStruct): void;
 //# sourceMappingURL=AbstractStruct.d.ts.map

package/dist/src/structs/AbstractStruct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractStruct.d.ts","sourceRoot":"","sources":["../../../src/structs/AbstractStruct.js"],"names":[],"mappings":"AAMA;IACE;;;OAGG;IACH,gBAHW,EAAE,UACF,MAAM,EAKhB;IAFC,OAAY;IACZ,eAAoB;IAGtB;;OAEG;IACH,eAFU,OAAO,CAIhB;IAED;;;;;;OAMG;IACH,iBAHW,cAAc,GACb,OAAO,CAIlB;IAED;;;;OAIG;IACH,eAJW,eAAe,GAAG,eAAe,UACjC,MAAM,eACN,MAAM,QAIhB;IAED;;;OAGG;IACH,uBAHW,WAAW,UACX,MAAM,QAIhB;IAED;;;OAGG;IACH,aAHW,MAAM,GACL,OAAO,iBAAiB,EAAE,EAAE,GAAC,OAAO,iBAAiB,EAAE,IAAI,CAItE;CACF;mBAxDM,iBAAiB;gCAAjB,iBAAiB;gCAAjB,iBAAiB;4BAAjB,iBAAiB"}
+{"version":3,"file":"AbstractStruct.d.ts","sourceRoot":"","sources":["../../../src/structs/AbstractStruct.js"],"names":[],"mappings":"AAEA;IACE;;;OAGG;IACH,gBAHW,EAAE,UACF,MAAM,EAKhB;IAFC,6BAAY;IACZ,eAAoB;IAGtB;;OAEG;IACH,eAFU,OAAO,CAIhB;IAED;;;;;;OAMG;IACH,kBAHW,EAAE,GAAC,IAAI,GAAC,IAAI,GACX,OAAO,CAIlB;IAED;;;;OAIG;IACH,gBAJW,eAAe,GAAG,eAAe,WACjC,MAAM,gBACN,MAAM,QAIhB;IAED;;;OAGG;IACH,wBAHW,WAAW,WACX,MAAM,QAIhB;IAED;;;OAGG;IACH,cAHW,MAAM,GACL,EAAE,GAAC,IAAI,GAAC,IAAI,CAIvB;CACF;AASM,wCANI,KAAK,UACL,cAAc,QAKqF"}

package/dist/src/structs/GC.d.ts

@@ -4,17 +4,6 @@ export const structGCRefNumber: 0;
  */
 export class GC extends AbstractStruct {
     delete(): void;
-    /**
-     * @param {GC} right
-     * @return {boolean}
-     */
-    mergeWith(right: GC): boolean;
-    /**
-     * @param {Transaction} _transaction
-     * @param {StructStore} _store
-     * @return {null | number}
-     */
-    getMissing(_transaction: Transaction, _store: StructStore): null | number;
     /**
      * gc structs can't be spliced.
      *
@@ -24,8 +13,14 @@ export class GC extends AbstractStruct {
      * @param {number} diff
      */
     splice(diff: number): GC;
+    /**
+     * @type {0}
+     */
+    ref: 0;
+    /**
+     * @type {false}
+     */
+    isItem: false;
 }
-import { AbstractStruct } from '../internals.js';
-import { Transaction } from '../internals.js';
-import { StructStore } from '../internals.js';
+import { AbstractStruct } from './AbstractStruct.js';
 //# sourceMappingURL=GC.d.ts.map

package/dist/src/structs/GC.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GC.d.ts","sourceRoot":"","sources":["../../../src/structs/GC.js"],"names":[],"mappings":"AASA,gCAAiC,CAAC,CAAA;AAElC;;GAEG;AACH;IAKE,eAAY;IAEZ;;;OAGG;IACH,iBAHW,EAAE,GACD,OAAO,CAQlB;IA0BD;;;;OAIG;IACH,yBAJW,WAAW,UACX,WAAW,GACV,IAAI,GAAG,MAAM,CAIxB;IAED;;;;;;;OAOG;IACH,aAFW,MAAM,MAMhB;CACF;+BAxEM,iBAAiB;4BAAjB,iBAAiB;4BAAjB,iBAAiB"}
+{"version":3,"file":"GC.d.ts","sourceRoot":"","sources":["../../../src/structs/GC.js"],"names":[],"mappings":"AAGA,gCAAiC,CAAC,CAAA;AAElC;;GAEG;AACH;IAKE,eAAY;IAsCZ;;;;;;;OAOG;IACH,aAFW,MAAM,MAMhB;IAGH;;OAEG;IACH,KAFU,CAAC,CAEK;IAEhB;;OAEG;IACH,QAFU,KAAK,CAEI;CAVlB;+BAhEgD,qBAAqB"}