Compare commits
No commits in common. "main" and "v13.6.9" have entirely different histories.
@ -26,7 +26,7 @@ article](https://blog.kevinjahns.de/are-crdts-suitable-for-shared-editing/).
|
|||||||
|
|
||||||
Each client is assigned a unique *clientID* property on first insert. This is a
|
Each client is assigned a unique *clientID* property on first insert. This is a
|
||||||
random 53-bit integer (53 bits because that fits in the javascript safe integer
|
random 53-bit integer (53 bits because that fits in the javascript safe integer
|
||||||
range \[JavaScript uses IEEE 754 floats\]).
|
range).
|
||||||
|
|
||||||
## List items
|
## List items
|
||||||
|
|
||||||
@ -60,7 +60,7 @@ characters have either been deleted or all characters are not deleted. The item
|
|||||||
will be split if the run is interrupted for any reason (eg a character in the
|
will be split if the run is interrupted for any reason (eg a character in the
|
||||||
middle of the run is deleted).
|
middle of the run is deleted).
|
||||||
|
|
||||||
When an item is created, it stores a reference to the IDs of the preceding and
|
When an item is created, it stores a reference to the IDs of the preceeding and
|
||||||
succeeding item. These are stored in the item's `origin` and `originRight`
|
succeeding item. These are stored in the item's `origin` and `originRight`
|
||||||
fields, respectively. These are used when peers concurrently insert at the same
|
fields, respectively. These are used when peers concurrently insert at the same
|
||||||
location in a document. Though quite rare in practice, Yjs needs to make sure
|
location in a document. Though quite rare in practice, Yjs needs to make sure
|
||||||
@ -88,7 +88,7 @@ When a local insert happens, Yjs needs to map the insert position in the
|
|||||||
document (eg position 1000) to an ID. With just the linked list, this would
|
document (eg position 1000) to an ID. With just the linked list, this would
|
||||||
require a slow O(n) linear scan of the list. But when editing a document, most
|
require a slow O(n) linear scan of the list. But when editing a document, most
|
||||||
inserts are either at the same position as the last insert, or nearby. To
|
inserts are either at the same position as the last insert, or nearby. To
|
||||||
improve performance, Yjs stores a cache of the 80 most recently looked up
|
improve performance, Yjs stores a cache of the 10 most recently looked up
|
||||||
insert positions in the document. This is consulted and updated when a position
|
insert positions in the document. This is consulted and updated when a position
|
||||||
is looked up to improve performance in the average case. The cache is updated
|
is looked up to improve performance in the average case. The cache is updated
|
||||||
using a heuristic that is still changing (currently, it is updated when a new
|
using a heuristic that is still changing (currently, it is updated when a new
|
||||||
|
252
README.md
252
README.md
@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
> A CRDT framework with a powerful abstraction of shared data
|
> A CRDT framework with a powerful abstraction of shared data
|
||||||
|
|
||||||
Yjs is a [CRDT implementation](#yjs-crdt-algorithm) that exposes its internal
|
Yjs is a [CRDT implementation](#Yjs-CRDT-Algorithm) that exposes its internal
|
||||||
data structure as *shared types*. Shared types are common data types like `Map`
|
data structure as *shared types*. Shared types are common data types like `Map`
|
||||||
or `Array` with superpowers: changes are automatically distributed to other
|
or `Array` with superpowers: changes are automatically distributed to other
|
||||||
peers and merged without merge conflicts.
|
peers and merged without merge conflicts.
|
||||||
@ -32,34 +32,13 @@ Otherwise you can find help on our community [discussion board](https://discuss.
|
|||||||
Please contribute to the project financially - especially if your company relies
|
Please contribute to the project financially - especially if your company relies
|
||||||
on Yjs. [](https://github.com/sponsors/dmonad)
|
on Yjs. [](https://github.com/sponsors/dmonad)
|
||||||
|
|
||||||
## Professional Support
|
|
||||||
|
|
||||||
* [Support Contract with the Maintainer](https://github.com/sponsors/dmonad) -
|
|
||||||
By contributing financially to the open-source Yjs project, you can receive
|
|
||||||
professional support directly from the author. This includes the opportunity for
|
|
||||||
weekly video calls to discuss your specific challenges.
|
|
||||||
* [Synergy Codes](https://synergycodes.com/yjs-services/) - Specializing in
|
|
||||||
consulting and developing real-time collaborative editing solutions for visual
|
|
||||||
apps, Synergy Codes focuses on interactive diagrams, complex graphs, charts, and
|
|
||||||
various data visualization types. Their expertise empowers developers to build
|
|
||||||
engaging and interactive visual experiences leveraging the power of Yjs. See
|
|
||||||
their work in action at [Visual Collaboration
|
|
||||||
Showcase](https://yjs-diagram.synergy.codes/).
|
|
||||||
|
|
||||||
## Who is using Yjs
|
## Who is using Yjs
|
||||||
|
|
||||||
* [AFFiNE](https://affine.pro/) A local-first, privacy-first, open source
|
* [AFFiNE](https://affine.pro/) A local-first, privacy-first, open source
|
||||||
knowledge base. :star2:
|
knowledge base. 🏅
|
||||||
* [Huly](https://huly.io/) - Open Source All-in-One Project Management Platform :star2:
|
* [Dynaboard](https://dynaboard.com/) Build web apps collaboratively. :star2:
|
||||||
* [Cargo](https://cargo.site/) Site builder for designers and artists :star2:
|
* [Sana](https://sanalabs.com/) A learning platform with collaborative text
|
||||||
* [Gitbook](https://gitbook.com) Knowledge management for technical teams :star2:
|
editing powered by Yjs.
|
||||||
* [Evernote](https://evernote.com) Note-taking app :star2:
|
|
||||||
* [Lessonspace](https://thelessonspace.com) Enterprise platform for virtual
|
|
||||||
classrooms and online training :star2:
|
|
||||||
* [Ellipsus](ellipsus.com) - Collaborative writing app for storytelling etc.
|
|
||||||
Supports versioning, change attribution, and "blame". A solution for the whole
|
|
||||||
publishing process (also selling) :star:
|
|
||||||
* [Dynaboard](https://dynaboard.com/) Build web apps collaboratively. :star:
|
|
||||||
* [Relm](https://www.relm.us/) A collaborative gameworld for teamwork and
|
* [Relm](https://www.relm.us/) A collaborative gameworld for teamwork and
|
||||||
community. :star:
|
community. :star:
|
||||||
* [Room.sh](https://room.sh/) A meeting application with integrated
|
* [Room.sh](https://room.sh/) A meeting application with integrated
|
||||||
@ -68,24 +47,15 @@ Showcase](https://yjs-diagram.synergy.codes/).
|
|||||||
Nimbus Web. :star:
|
Nimbus Web. :star:
|
||||||
* [Pluxbox RadioManager](https://getradiomanager.com/) A web-based app to
|
* [Pluxbox RadioManager](https://getradiomanager.com/) A web-based app to
|
||||||
collaboratively organize radio broadcasts. :star:
|
collaboratively organize radio broadcasts. :star:
|
||||||
* [modyfi](https://www.modyfi.com) - Modyfi is the design platform built for
|
|
||||||
multidisciplinary designers. Design, generate, animate, and more — without
|
|
||||||
switching between apps. :star:
|
|
||||||
* [Sana](https://sanalabs.com/) A learning platform with collaborative text
|
|
||||||
editing powered by Yjs.
|
|
||||||
* [Serenity Notes](https://www.serenity.re/en/notes) End-to-end encrypted
|
* [Serenity Notes](https://www.serenity.re/en/notes) End-to-end encrypted
|
||||||
collaborative notes app.
|
collaborative notes app.
|
||||||
* [PRSM](https://prsm.uk/) Collaborative mind-mapping and system visualisation.
|
* [PRSM](https://prsm.uk/) Collaborative mind-mapping and system visualisation. *[(source)](https://github.com/micrology/prsm)*
|
||||||
*[(source)](https://github.com/micrology/prsm)*
|
|
||||||
* [Alldone](https://alldone.app/) A next-gen project management and
|
* [Alldone](https://alldone.app/) A next-gen project management and
|
||||||
collaboration platform.
|
collaboration platform.
|
||||||
* [Living Spec](https://livingspec.com/) A modern way for product teams to collaborate.
|
* [Living Spec](https://livingspec.com/) A modern way for product teams to collaborate.
|
||||||
* [Slidebeamer](https://slidebeamer.com/) Presentation app.
|
* [Slidebeamer](https://slidebeamer.com/) Presentation app.
|
||||||
* [BlockSurvey](https://blocksurvey.io) End-to-end encryption for your forms/surveys.
|
* [BlockSurvey](https://blocksurvey.io) End-to-end encryption for your forms/surveys.
|
||||||
* [Skiff](https://skiff.org/) Private, decentralized workspace.
|
* [Skiff](https://skiff.org/) Private, decentralized workspace.
|
||||||
* [JupyterLab](https://jupyter.org/) Collaborative computational Notebooks
|
|
||||||
* [JupyterCad](https://jupytercad.readthedocs.io/en/latest/) Extension to
|
|
||||||
JupyterLab that enables collaborative editing of 3d FreeCAD Models.
|
|
||||||
* [Hyperquery](https://hyperquery.ai/) A collaborative data workspace for
|
* [Hyperquery](https://hyperquery.ai/) A collaborative data workspace for
|
||||||
sharing analyses, documentation, spreadsheets, and dashboards.
|
sharing analyses, documentation, spreadsheets, and dashboards.
|
||||||
* [Nosgestesclimat](https://nosgestesclimat.fr/groupe) The french carbon
|
* [Nosgestesclimat](https://nosgestesclimat.fr/groupe) The french carbon
|
||||||
@ -96,50 +66,22 @@ Showcase](https://yjs-diagram.synergy.codes/).
|
|||||||
worldbuilding app for tabletop RPGs.
|
worldbuilding app for tabletop RPGs.
|
||||||
* [IllumiDesk](https://illumidesk.com/) Build courses and content with A.I.
|
* [IllumiDesk](https://illumidesk.com/) Build courses and content with A.I.
|
||||||
* [btw](https://www.btw.so) Open-source Medium alternative
|
* [btw](https://www.btw.so) Open-source Medium alternative
|
||||||
* [AWS SageMaker](https://aws.amazon.com/sagemaker/) Tools for building Machine
|
|
||||||
Learning Models
|
|
||||||
* [linear](https://linear.app) Streamline issues, projects, and product roadmaps.
|
|
||||||
* [AWS SageMaker](https://aws.amazon.com/sagemaker/) - Machine Learning Service
|
|
||||||
* [Arkiter](https://www.arkiter.com/) - Live interview software
|
|
||||||
* [Appflowy](https://www.appflowy.io/) - They use Yrs
|
|
||||||
* [Multi.app](https://multi.app) - Multiplayer app sharing: Point, draw and edit
|
|
||||||
in shared apps as if they're on your computer. They are using Yrs.
|
|
||||||
* [AppMaster](https://appmaster.io) A No-Code platform for creating
|
|
||||||
production-ready applications with source code generation.
|
|
||||||
* [Synthesia](https://www.synthesia.io) - Collaborative Video Editor
|
|
||||||
* [thinkdeli](https://thinkdeli.com) - A fast and simple notes app powered by AI
|
|
||||||
* [ourboard](https://github.com/raimohanska/ourboard) - A collaborative whiteboard
|
|
||||||
application
|
|
||||||
* [Ellie.ai](https://ellie.ai) - Data Product Design and Collaboration
|
|
||||||
* [GoPeer](https://gopeer.org/) - Collaborative tutoring
|
|
||||||
* [screen.garden](https://screen.garden) - Collaborative backend for PKM apps.
|
|
||||||
* [NextCloud](https://nextcloud.com/) - Content Collaboration Platform
|
|
||||||
* [keystatic](https://github.com/Thinkmill/keystatic) - git-based CMS
|
|
||||||
* [QDAcity](https://qdacity.com) - Collaborative qualitative data analysis platform
|
|
||||||
* [Kanbert](https://kanbert.com) - Project management software
|
|
||||||
* [Eclipse Theia](https://github.com/eclipse-theia/theia) - A cloud & desktop
|
|
||||||
IDE that runs in the browser.
|
|
||||||
* [ScienHub](https://scienhub.com) - Collaborative LaTeX editor in the browser.
|
|
||||||
* [Open Collaboration Tools](https://www.open-collab.tools/) - Collaborative
|
|
||||||
editing for your IDE or custom editor
|
|
||||||
* [Typst](https://typst.app/) - Compose, edit, and automate technical documents
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
* [Overview](#overview)
|
* [Overview](#Overview)
|
||||||
* [Bindings](#bindings)
|
* [Bindings](#Bindings)
|
||||||
* [Providers](#providers)
|
* [Providers](#Providers)
|
||||||
* [Tooling](#tooling)
|
* [Ports](#Ports)
|
||||||
* [Ports](#ports)
|
* [Getting Started](#Getting-Started)
|
||||||
* [Getting Started](#getting-started)
|
* [API](#API)
|
||||||
* [API](#api)
|
* [Shared Types](#Shared-Types)
|
||||||
* [Shared Types](#shared-types)
|
* [Y.Doc](#YDoc)
|
||||||
* [Y.Doc](#ydoc)
|
* [Document Updates](#Document-Updates)
|
||||||
* [Document Updates](#document-updates)
|
* [Relative Positions](#Relative-Positions)
|
||||||
* [Relative Positions](#relative-positions)
|
* [Y.UndoManager](#YUndoManager)
|
||||||
* [Y.UndoManager](#yundomanager)
|
* [Yjs CRDT Algorithm](#Yjs-CRDT-Algorithm)
|
||||||
* [Yjs CRDT Algorithm](#yjs-crdt-algorithm)
|
* [License and Author](#License-and-Author)
|
||||||
* [License and Author](#license-and-author)
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@ -157,14 +99,9 @@ are implemented in separate modules.
|
|||||||
| [Monaco](https://microsoft.github.io/monaco-editor/) | ✔ | [y-monaco](https://github.com/yjs/y-monaco) | [demo](https://demos.yjs.dev/monaco/monaco.html) |
|
| [Monaco](https://microsoft.github.io/monaco-editor/) | ✔ | [y-monaco](https://github.com/yjs/y-monaco) | [demo](https://demos.yjs.dev/monaco/monaco.html) |
|
||||||
| [Slate](https://github.com/ianstormtaylor/slate) | ✔ | [slate-yjs](https://github.com/bitphinix/slate-yjs) | [demo](https://bitphinix.github.io/slate-yjs-example) |
|
| [Slate](https://github.com/ianstormtaylor/slate) | ✔ | [slate-yjs](https://github.com/bitphinix/slate-yjs) | [demo](https://bitphinix.github.io/slate-yjs-example) |
|
||||||
| [BlockSuite](https://github.com/toeverything/blocksuite) | ✔ | (native) | [demo](https://blocksuite-toeverything.vercel.app/?init) |
|
| [BlockSuite](https://github.com/toeverything/blocksuite) | ✔ | (native) | [demo](https://blocksuite-toeverything.vercel.app/?init) |
|
||||||
| [Lexical](https://lexical.dev/) | ✔ | (native) | [demo](https://lexical.dev/docs/collaboration/react#see-it-in-action) |
|
|
||||||
| [valtio](https://github.com/pmndrs/valtio) | | [valtio-yjs](https://github.com/dai-shi/valtio-yjs) | [demo](https://codesandbox.io/s/valtio-yjs-demo-ox3iy) |
|
| [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) |
|
| [immer](https://github.com/immerjs/immer) | | [immer-yjs](https://github.com/sep2/immer-yjs) | [demo](https://codesandbox.io/s/immer-yjs-demo-6e0znb) |
|
||||||
| 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) |
|
| 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) |
|
|
||||||
| [Rows n'Columns](https://www.rowsncolumns.app/) | ✔ | [@rowsncolumns/y-spreadsheet](https://docs.rowsncolumns.app/collaboration/yjs-collaboration) | |
|
|
||||||
|
|
||||||
### Providers
|
### Providers
|
||||||
|
|
||||||
@ -173,56 +110,26 @@ and storing shared data for offline usage is quite a hassle. **Providers**
|
|||||||
manage all that for you and are the perfect starting point for your
|
manage all that for you and are the perfect starting point for your
|
||||||
collaborative app.
|
collaborative app.
|
||||||
|
|
||||||
> This list of providers is incomplete. Please open PRs to add your providers to
|
|
||||||
> this list!
|
|
||||||
|
|
||||||
#### Connection Providers
|
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt><a href="https://github.com/yjs/y-websocket">y-websocket</a></dt>
|
|
||||||
<dd>
|
|
||||||
A module that contains a simple websocket backend and a websocket client that
|
|
||||||
connects to that backend. <a href="https://github.com/yjs/y-redis/"><b>y-redis</b></a>,
|
|
||||||
<b>y-sweet</b>, <b>ypy-websocket</b> and <a href="https://tiptap.dev/docs/hocuspocus/introduction">
|
|
||||||
<b>Hocuspocus</b></a> (see below) are alternative
|
|
||||||
backends to y-websocket.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://github.com/yjs/y-webrtc">y-webrtc</a></dt>
|
<dt><a href="https://github.com/yjs/y-webrtc">y-webrtc</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
Propagates document updates peer-to-peer using WebRTC. The peers exchange
|
Propagates document updates peer-to-peer using WebRTC. The peers exchange
|
||||||
signaling data over signaling servers. Publicly available signaling servers
|
signaling data over signaling servers. Publically available signaling servers
|
||||||
are available. Communication over the signaling servers can be encrypted by
|
are available. Communication over the signaling servers can be encrypted by
|
||||||
providing a shared secret, keeping the connection information and the shared
|
providing a shared secret, keeping the connection information and the shared
|
||||||
document private.
|
document private.
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/liveblocks/liveblocks">@liveblocks/yjs </a> 🌟</dt>
|
<dt><a href="https://github.com/yjs/y-websocket">y-websocket</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
<a href="https://liveblocks.io/document/yjs">Liveblocks Yjs</a> provides a fully
|
A module that contains a simple websocket backend and a websocket client that
|
||||||
hosted WebSocket infrastructure and persisted data store for Yjs
|
connects to that backend. The backend can be extended to persist updates in a
|
||||||
documents. No configuration or maintenance is required. It also features
|
leveldb database.
|
||||||
Yjs webhook events, REST API to read and update Yjs documents, and a
|
|
||||||
browser DevTools extension.
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/drifting-in-space/y-sweet">y-sweet</a> ⭐</dt>
|
<dt><a href="https://github.com/yjs/y-indexeddb">y-indexeddb</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
A standalone yjs server with persistence to S3 or filesystem. They offer a
|
Efficiently persists document updates to the browsers indexeddb database.
|
||||||
<a href="https://y-sweet.cloud">cloud service</a> as well.
|
The document is immediately available and only diffs need to be synced through the
|
||||||
</dd>
|
network provider.
|
||||||
<dt><a href="https://github.com/ueberdosis/hocuspocus">Hocuspocus</a> ⭐</dt>
|
|
||||||
<dd>
|
|
||||||
A standalone extensible yjs server with sqlite persistence, webhooks, auth and more.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://docs.superviz.com/collaboration/integrations/YJS/overview">@superviz/yjs</a></dt>
|
|
||||||
<dd>
|
|
||||||
SuperViz Yjs Provider comes with a secure, scalable real-time infrastructure
|
|
||||||
for Yjs documents, fully compatible with a set of real-time
|
|
||||||
collaboration components offered by SuperViz. This solution ensures
|
|
||||||
synchronization, offline editing, and real-time updates, enabling
|
|
||||||
multiple users to collaborate effectively within shared workspaces.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://docs.partykit.io/reference/y-partykit-api/">PartyKit</a></dt>
|
|
||||||
<dd>
|
|
||||||
Cloud service for building multiplayer apps.
|
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/marcopolo/y-libp2p">y-libp2p</a></dt>
|
<dt><a href="https://github.com/marcopolo/y-libp2p">y-libp2p</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
@ -237,6 +144,14 @@ Also includes a peer-sync mechanism to catch up on missed updates.
|
|||||||
an append-only log of CRDT local updates (hypercore). Multifeed manages and sync
|
an append-only log of CRDT local updates (hypercore). Multifeed manages and sync
|
||||||
hypercores and y-dat listens to changes and applies them to the Yjs document.
|
hypercores and y-dat listens to changes and applies them to the Yjs document.
|
||||||
</dd>
|
</dd>
|
||||||
|
<dt><a href="https://github.com/liveblocks/liveblocks">@liveblocks/yjs</a></dt>
|
||||||
|
<dd>
|
||||||
|
<a href="https://liveblocks.io/document/yjs">Liveblocks Yjs</a> provides a fully
|
||||||
|
hosted WebSocket infrastructure and persisted data store for Yjs
|
||||||
|
documents. No configuration or maintenance is required. It also features
|
||||||
|
Yjs webhook events, REST API to read and update Yjs documents, and a
|
||||||
|
browser DevTools extension.
|
||||||
|
</dd>
|
||||||
<dt><a href="https://github.com/yousefED/matrix-crdt">Matrix-CRDT</a></dt>
|
<dt><a href="https://github.com/yousefED/matrix-crdt">Matrix-CRDT</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
Use <a href="https://www.matrix.org">Matrix</a> as an off-the-shelf backend for
|
Use <a href="https://www.matrix.org">Matrix</a> as an off-the-shelf backend for
|
||||||
@ -245,74 +160,20 @@ Use Matrix as transport and storage of Yjs updates, so you can focus building
|
|||||||
your client app and Matrix can provide powerful features like Authentication,
|
your client app and Matrix can provide powerful features like Authentication,
|
||||||
Authorization, Federation, hosting (self-hosting or SaaS) and even End-to-End
|
Authorization, Federation, hosting (self-hosting or SaaS) and even End-to-End
|
||||||
Encryption (E2EE).
|
Encryption (E2EE).
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/y-crdt/yrb-actioncable">yrb-actioncable</a></dt>
|
|
||||||
<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/y-crdt/ypy-websocket">ypy-websocket</a></dt>
|
|
||||||
<dd>
|
|
||||||
Websocket backend, written in Python.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://tinybase.org/">Tinybase</a></dt>
|
|
||||||
<dd>
|
|
||||||
The reactive data store for local-first apps. They support multiple CRDTs and
|
|
||||||
different network technologies.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://codeberg.org/webxdc/y-webxdc">y-webxdc</a></dt>
|
|
||||||
<dd>
|
|
||||||
Provider for sharing data in <a href="https://webxdc.org">webxdc chat apps</a>.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://www.secsync.com/">secsync</a></dt>
|
|
||||||
<dd>
|
|
||||||
An architecture to relay end-to-end encrypted CRDTs over a central service.
|
|
||||||
</dd>
|
|
||||||
|
|
||||||
</dl>
|
|
||||||
|
|
||||||
#### Persistence Providers
|
|
||||||
|
|
||||||
<dl>
|
|
||||||
<dt><a href="https://github.com/yjs/y-indexeddb">y-indexeddb</a></dt>
|
|
||||||
<dd>
|
|
||||||
Efficiently persists document updates to the browsers indexeddb database.
|
|
||||||
The document is immediately available and only diffs need to be synced through the
|
|
||||||
network provider.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://github.com/MaxNoetzold/y-mongodb-provider">y-mongodb-provider</a></dt>
|
<dt><a href="https://github.com/MaxNoetzold/y-mongodb-provider">y-mongodb-provider</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
Adds persistent storage to a server with MongoDB. Can be used with the
|
Adds persistent storage to a server with MongoDB. Can be used with the
|
||||||
y-websocket provider.
|
y-websocket provider.
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/podraven/y-fire">y-fire</a></dt>
|
<dt><a href="https://github.com/toeverything/AFFiNE/tree/master/packages/y-indexeddb">
|
||||||
|
@toeverything/y-indexeddb</a></dt>
|
||||||
<dd>
|
<dd>
|
||||||
A database and connection provider for Yjs based on Firestore.
|
Like y-indexeddb, but with sub-documents support and fully TypeScript.
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="https://github.com/malte-j/y-op-sqlite">y-op-sqlite</a></dt>
|
|
||||||
<dd>
|
|
||||||
Persist YJS updates in your React Native app using
|
|
||||||
<a href="https://github.com/OP-Engineering/op-sqlite">op-sqlite</a>
|
|
||||||
, the fastest SQLite library for React Native.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://github.com/MaxNoetzold/y-postgresql">y-postgresql</a></dt>
|
|
||||||
<dd>
|
|
||||||
Provides persistent storage for a web server using PostgreSQL and
|
|
||||||
is easily compatible with y-websocket.
|
|
||||||
</dd>
|
|
||||||
<dt><a href="https://github.com/kapv89/k_yrs_go">k_yrs_go</a></dt>
|
|
||||||
<dd>
|
|
||||||
Golang database server for YJS CRDT using Postgres + Redis
|
|
||||||
</dd>
|
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
### Tooling
|
# Ports
|
||||||
|
|
||||||
* [y-sweet debugger](https://docs.jamsocket.com/y-sweet/advanced/debugger)
|
|
||||||
* [liveblocks devtools](https://liveblocks.io/devtools)
|
|
||||||
* [Yjs inspector](https://inspector.yjs.dev)
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
There are several Yjs-compatible ports to other programming languages.
|
There are several Yjs-compatible ports to other programming languages.
|
||||||
|
|
||||||
@ -326,7 +187,6 @@ language bindings to other languages
|
|||||||
* [yswift](https://github.com/y-crdt/yswift) - Swift binding
|
* [yswift](https://github.com/y-crdt/yswift) - Swift binding
|
||||||
* [yffi](https://github.com/y-crdt/y-crdt/tree/main/yffi) - C-FFI
|
* [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
|
* [ywasm](https://github.com/y-crdt/y-crdt/tree/main/ywasm) - WASM binding
|
||||||
* [y_ex](https://github.com/satoren/y_ex) - Elixir bindings
|
|
||||||
* [ycs](https://github.com/yjs/ycs) - .Net compatible C# implementation.
|
* [ycs](https://github.com/yjs/ycs) - .Net compatible C# implementation.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
@ -340,7 +200,7 @@ npm i yjs y-websocket
|
|||||||
Start the y-websocket server:
|
Start the y-websocket server:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
PORT=1234 node ./node_modules/y-websocket/bin/server.cjs
|
PORT=1234 node ./node_modules/y-websocket/bin/server.js
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example: Observe types
|
### Example: Observe types
|
||||||
@ -441,11 +301,6 @@ necessary.
|
|||||||
</p>
|
</p>
|
||||||
<pre>const yarray = new Y.Array()</pre>
|
<pre>const yarray = new Y.Array()</pre>
|
||||||
<dl>
|
<dl>
|
||||||
<b><code>
|
|
||||||
Y.Array.from(Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>):
|
|
||||||
Y.Array
|
|
||||||
</code></b>
|
|
||||||
<dd>An alternative factory function to create a Y.Array based on existing content.</dd>
|
|
||||||
<b><code>parent:Y.AbstractType|null</code></b>
|
<b><code>parent:Y.AbstractType|null</code></b>
|
||||||
<dd></dd>
|
<dd></dd>
|
||||||
<b><code>insert(index:number, content:Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>)</code></b>
|
<b><code>insert(index:number, content:Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type>)</code></b>
|
||||||
@ -475,11 +330,6 @@ forEach(function(value:object|boolean|Array|string|number|null|Uint8Array|Y.Type
|
|||||||
<dd></dd>
|
<dd></dd>
|
||||||
<b><code>map(function(T, number, YArray):M):Array<M></code></b>
|
<b><code>map(function(T, number, YArray):M):Array<M></code></b>
|
||||||
<dd></dd>
|
<dd></dd>
|
||||||
<b><code>clone(): Y.Array</code></b>
|
|
||||||
<dd>
|
|
||||||
Clone all values into a fresh Y.Array instance. The returned type can be
|
|
||||||
included into the Yjs document.
|
|
||||||
</dd>
|
|
||||||
<b><code>toArray():Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type></code></b>
|
<b><code>toArray():Array<object|boolean|Array|string|number|null|Uint8Array|Y.Type></code></b>
|
||||||
<dd>Copies the content of this YArray to a new Array.</dd>
|
<dd>Copies the content of this YArray to a new Array.</dd>
|
||||||
<b><code>toJSON():Array<Object|boolean|Array|string|number|null></code></b>
|
<b><code>toJSON():Array<Object|boolean|Array|string|number|null></code></b>
|
||||||
@ -536,6 +386,8 @@ or any of its children.
|
|||||||
<dd></dd>
|
<dd></dd>
|
||||||
<b><code>has(key:string):boolean</code></b>
|
<b><code>has(key:string):boolean</code></b>
|
||||||
<dd></dd>
|
<dd></dd>
|
||||||
|
<b><code>get(index:number)</code></b>
|
||||||
|
<dd></dd>
|
||||||
<b><code>clear()</code></b>
|
<b><code>clear()</code></b>
|
||||||
<dd>Removes all elements from this YMap.</dd>
|
<dd>Removes all elements from this YMap.</dd>
|
||||||
<b><code>clone():Y.Map</code></b>
|
<b><code>clone():Y.Map</code></b>
|
||||||
@ -832,8 +684,6 @@ type. Doesn't log types that have not been defined (using
|
|||||||
<dd>Define a shared Y.Map type. Is equivalent to <code>y.get(string, Y.Map)</code>.</dd>
|
<dd>Define a shared Y.Map type. Is equivalent to <code>y.get(string, Y.Map)</code>.</dd>
|
||||||
<b><code>getText(string):Y.Text</code></b>
|
<b><code>getText(string):Y.Text</code></b>
|
||||||
<dd>Define a shared Y.Text type. Is equivalent to <code>y.get(string, Y.Text)</code>.</dd>
|
<dd>Define a shared Y.Text type. Is equivalent to <code>y.get(string, Y.Text)</code>.</dd>
|
||||||
<b><code>getXmlElement(string, string):Y.XmlElement</code></b>
|
|
||||||
<dd>Define a shared Y.XmlElement type. Is equivalent to <code>y.get(string, Y.XmlElement)</code>.</dd>
|
|
||||||
<b><code>getXmlFragment(string):Y.XmlFragment</code></b>
|
<b><code>getXmlFragment(string):Y.XmlFragment</code></b>
|
||||||
<dd>Define a shared Y.XmlFragment type. Is equivalent to <code>y.get(string, Y.XmlFragment)</code>.</dd>
|
<dd>Define a shared Y.XmlFragment type. Is equivalent to <code>y.get(string, Y.XmlFragment)</code>.</dd>
|
||||||
<b><code>on(string, function)</code></b>
|
<b><code>on(string, function)</code></b>
|
||||||
@ -889,7 +739,7 @@ doc1.getArray('myarray').insert(0, ['Hello doc2, you got this?'])
|
|||||||
doc2.getArray('myarray').get(0) // => 'Hello doc2, you got this?'
|
doc2.getArray('myarray').get(0) // => 'Hello doc2, you got this?'
|
||||||
```
|
```
|
||||||
|
|
||||||
Yjs internally maintains a [state vector](#state-vector) that denotes the next
|
Yjs internally maintains a [state vector](#State-Vector) that denotes the next
|
||||||
expected clock from each client. In a different interpretation it holds the
|
expected clock from each client. In a different interpretation it holds the
|
||||||
number of structs created by each client. When two clients sync, you can either
|
number of structs created by each client. When two clients sync, you can either
|
||||||
exchange the complete document structure or only the differences by sending the
|
exchange the complete document structure or only the differences by sending the
|
||||||
@ -971,7 +821,7 @@ ydoc2.getText().toString() // => "00000000000"
|
|||||||
#### Using V2 update format
|
#### Using V2 update format
|
||||||
|
|
||||||
Yjs implements two update formats. By default you are using the V1 update format.
|
Yjs implements two update formats. By default you are using the V1 update format.
|
||||||
You can opt-in into the V2 update format which provides much better compression.
|
You can opt-in into the V2 update format wich provides much better compression.
|
||||||
It is not yet used by all providers. However, you can already use it if
|
It is not yet used by all providers. However, you can already use it if
|
||||||
you are building your own provider. All below functions are available with the
|
you are building your own provider. All below functions are available with the
|
||||||
suffix "V2". E.g. `Y.applyUpdate` ⇒ `Y.applyUpdateV2`. Also when listening to updates
|
suffix "V2". E.g. `Y.applyUpdate` ⇒ `Y.applyUpdateV2`. Also when listening to updates
|
||||||
@ -1102,7 +952,7 @@ encoding format for document updates. If you prefer JSON encoding, you can
|
|||||||
simply JSON.stringify / JSON.parse the relative position instead.
|
simply JSON.stringify / JSON.parse the relative position instead.
|
||||||
</dd>
|
</dd>
|
||||||
<b><code>Y.decodeRelativePosition(Uint8Array):RelativePosition</code></b>
|
<b><code>Y.decodeRelativePosition(Uint8Array):RelativePosition</code></b>
|
||||||
<dd>Decode a binary-encoded relative position to a RelativePosition object.</dd>
|
<dd>Decode a binary-encoded relative position to a RelativePositon object.</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
### Y.UndoManager
|
### Y.UndoManager
|
||||||
@ -1282,11 +1132,11 @@ More information about the specific implementation is available in
|
|||||||
|
|
||||||
CRDTs that are suitable for shared text editing suffer from the fact that they
|
CRDTs that are suitable for shared text editing suffer from the fact that they
|
||||||
only grow in size. There are CRDTs that do not grow in size, but they do not
|
only grow in size. There are CRDTs that do not grow in size, but they do not
|
||||||
have the characteristics that are beneficial for shared text editing (like
|
have the characteristics that are benificial for shared text editing (like
|
||||||
intention preservation). Yjs implements many improvements to the original
|
intention preservation). Yjs implements many improvements to the original
|
||||||
algorithm that diminish the trade-off that the document only grows in size. We
|
algorithm that diminish the trade-off that the document only grows in size. We
|
||||||
can't garbage collect deleted structs (tombstones) while ensuring a unique
|
can't garbage collect deleted structs (tombstones) while ensuring a unique
|
||||||
order of the structs. But we can 1. merge preceding structs into a single
|
order of the structs. But we can 1. merge preceeding structs into a single
|
||||||
struct to reduce the amount of meta information, 2. we can delete content from
|
struct to reduce the amount of meta information, 2. we can delete content from
|
||||||
the struct if it is deleted, and 3. we can garbage collect tombstones if we
|
the struct if it is deleted, and 3. we can garbage collect tombstones if we
|
||||||
don't care about the order of the structs anymore (e.g. if the parent was
|
don't care about the order of the structs anymore (e.g. if the parent was
|
||||||
|
142
funding.json
142
funding.json
@ -1,142 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "v1.0.0",
|
|
||||||
"entity": {
|
|
||||||
"type": "group",
|
|
||||||
"role": "steward",
|
|
||||||
"name": "Kevin Jahns",
|
|
||||||
"email": "kevin.jahns@protonmail.com",
|
|
||||||
"phone": "",
|
|
||||||
"description": "OSS Developer",
|
|
||||||
"webpageUrl": {
|
|
||||||
"url": "https://github.com/yjs"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"projects": [
|
|
||||||
{
|
|
||||||
"guid": "yjs",
|
|
||||||
"name": "Yjs",
|
|
||||||
"description": "A library for building collaborative applications. #p2p #local-first #CRDT Funding this project will also enable me to maintain the other Yjs-related technologies.",
|
|
||||||
"webpageUrl": {
|
|
||||||
"url": "https://github.com/yjs/yjs"
|
|
||||||
},
|
|
||||||
"repositoryUrl": {
|
|
||||||
"url": "https://github.com/yjs/yjs"
|
|
||||||
},
|
|
||||||
"licenses": [
|
|
||||||
"spdx:MIT"
|
|
||||||
],
|
|
||||||
"tags": [
|
|
||||||
"collaboration",
|
|
||||||
"p2p",
|
|
||||||
"CRDT",
|
|
||||||
"rich-text",
|
|
||||||
"real-time"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "Titanic",
|
|
||||||
"name": "Y/Titanic",
|
|
||||||
"description": "A provider for syncing millions of docs efficiently with other peers. This will become the foundation for building real local-first apps with Yjs.",
|
|
||||||
"webpageUrl": {
|
|
||||||
"url": "https://github.com/yjs/titanic",
|
|
||||||
"wellKnown": "https://github.com/yjs/titanic/blob/main/.well-known/funding-manifest-urls"
|
|
||||||
},
|
|
||||||
"repositoryUrl": {
|
|
||||||
"url": "https://github.com/yjs/titanic",
|
|
||||||
"wellKnown": "https://github.com/yjs/titanic/blob/main/.well-known/funding-manifest-urls"
|
|
||||||
},
|
|
||||||
"licenses": [
|
|
||||||
"spdx:MIT"
|
|
||||||
],
|
|
||||||
"tags": [
|
|
||||||
"privacy",
|
|
||||||
"collaboration",
|
|
||||||
"p2p",
|
|
||||||
"CRDT",
|
|
||||||
"rich-text",
|
|
||||||
"real-time",
|
|
||||||
"web-development"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"funding": {
|
|
||||||
"channels": [
|
|
||||||
{
|
|
||||||
"guid": "github-sponsors",
|
|
||||||
"type": "payment-provider",
|
|
||||||
"address": "",
|
|
||||||
"description": "For funding of the Yjs project"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "y-collective",
|
|
||||||
"type": "payment-provider",
|
|
||||||
"address": "https://opencollective.com/y-collective",
|
|
||||||
"description": "For funding the Y-CRDT - the Rust implementation of Yjs and other listed projects."
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"plans": [
|
|
||||||
{
|
|
||||||
"guid": "supporter",
|
|
||||||
"status": "active",
|
|
||||||
"name": "Supporter",
|
|
||||||
"description": "",
|
|
||||||
"amount": 0,
|
|
||||||
"currency": "USD",
|
|
||||||
"frequency": "monthly",
|
|
||||||
"channels": [
|
|
||||||
"github-sponsors",
|
|
||||||
"y-collective"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "titanic-funding",
|
|
||||||
"status": "active",
|
|
||||||
"name": "Titanic Funding",
|
|
||||||
"description": "Fund the next generation of local-first providers.",
|
|
||||||
"amount": 30000,
|
|
||||||
"currency": "USD",
|
|
||||||
"frequency": "one-time",
|
|
||||||
"channels": [
|
|
||||||
"github-sponsors"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "bronze-sponsor",
|
|
||||||
"status": "active",
|
|
||||||
"name": "Bronze Sponsor",
|
|
||||||
"description": "This is the recommended plan for companies that use Yjs.",
|
|
||||||
"amount": 500,
|
|
||||||
"currency": "USD",
|
|
||||||
"frequency": "monthly",
|
|
||||||
"channels": [
|
|
||||||
"github-sponsors"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "silver-sponsor",
|
|
||||||
"status": "active",
|
|
||||||
"name": "Silver Sponsor",
|
|
||||||
"description": "This is the recommended plan for large/successfull companies that use Yjs.",
|
|
||||||
"amount": 1000,
|
|
||||||
"currency": "USD",
|
|
||||||
"frequency": "monthly",
|
|
||||||
"channels": [
|
|
||||||
"github-sponsors"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"guid": "gold-sponsor",
|
|
||||||
"status": "active",
|
|
||||||
"name": "Gold Sponsor",
|
|
||||||
"description": "This is the recommended plan for successful companies that build their entire product around Yjs-related technologies.",
|
|
||||||
"amount": 3000,
|
|
||||||
"currency": "USD",
|
|
||||||
"frequency": "monthly",
|
|
||||||
"channels": [
|
|
||||||
"github-sponsors"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"history": null
|
|
||||||
}
|
|
||||||
}
|
|
1742
package-lock.json
generated
1742
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
11
package.json
11
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "yjs",
|
"name": "yjs",
|
||||||
"version": "13.6.24",
|
"version": "13.6.9",
|
||||||
"description": "Shared Editing Library",
|
"description": "Shared Editing Library",
|
||||||
"main": "./dist/yjs.cjs",
|
"main": "./dist/yjs.cjs",
|
||||||
"module": "./dist/yjs.mjs",
|
"module": "./dist/yjs.mjs",
|
||||||
@ -12,10 +12,9 @@
|
|||||||
"url": "https://github.com/sponsors/dmonad"
|
"url": "https://github.com/sponsors/dmonad"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"clean": "rm -rf dist docs",
|
"test": "npm run dist && node ./dist/tests.cjs --repetition-time 50",
|
||||||
"test": "npm run dist && NODE_ENV=development node ./dist/tests.cjs --repetition-time 50",
|
|
||||||
"test-extensive": "npm run lint && npm run dist && node ./dist/tests.cjs --production --repetition-time 10000",
|
"test-extensive": "npm run lint && npm run dist && node ./dist/tests.cjs --production --repetition-time 10000",
|
||||||
"dist": "npm run clean && rollup -c && tsc",
|
"dist": "rm -rf dist && rollup -c && tsc",
|
||||||
"watch": "rollup -wc",
|
"watch": "rollup -wc",
|
||||||
"lint": "markdownlint README.md && standard && tsc",
|
"lint": "markdownlint README.md && standard && tsc",
|
||||||
"docs": "rm -rf docs; jsdoc --configure ./.jsdoc.json --verbose --readme ./README.md --package ./package.json || true",
|
"docs": "rm -rf docs; jsdoc --configure ./.jsdoc.json --verbose --readme ./README.md --package ./package.json || true",
|
||||||
@ -76,7 +75,7 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://docs.yjs.dev",
|
"homepage": "https://docs.yjs.dev",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"lib0": "^0.2.99"
|
"lib0": "^0.2.86"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@rollup/plugin-commonjs": "^24.0.1",
|
"@rollup/plugin-commonjs": "^24.0.1",
|
||||||
@ -85,7 +84,7 @@
|
|||||||
"concurrently": "^3.6.1",
|
"concurrently": "^3.6.1",
|
||||||
"http-server": "^0.12.3",
|
"http-server": "^0.12.3",
|
||||||
"jsdoc": "^3.6.7",
|
"jsdoc": "^3.6.7",
|
||||||
"markdownlint-cli": "^0.41.0",
|
"markdownlint-cli": "^0.23.2",
|
||||||
"rollup": "^3.20.0",
|
"rollup": "^3.20.0",
|
||||||
"standard": "^16.0.4",
|
"standard": "^16.0.4",
|
||||||
"tui-jsdoc-template": "^1.2.2",
|
"tui-jsdoc-template": "^1.2.2",
|
||||||
|
@ -50,11 +50,8 @@ export {
|
|||||||
findRootTypeKey,
|
findRootTypeKey,
|
||||||
findIndexSS,
|
findIndexSS,
|
||||||
getItem,
|
getItem,
|
||||||
getItemCleanStart,
|
|
||||||
getItemCleanEnd,
|
|
||||||
typeListToArraySnapshot,
|
typeListToArraySnapshot,
|
||||||
typeMapGetSnapshot,
|
typeMapGetSnapshot,
|
||||||
typeMapGetAllSnapshot,
|
|
||||||
createDocFromSnapshot,
|
createDocFromSnapshot,
|
||||||
iterateDeletedStructs,
|
iterateDeletedStructs,
|
||||||
applyUpdate,
|
applyUpdate,
|
||||||
@ -102,7 +99,6 @@ export {
|
|||||||
UpdateDecoderV1,
|
UpdateDecoderV1,
|
||||||
UpdateDecoderV2,
|
UpdateDecoderV2,
|
||||||
equalDeleteSets,
|
equalDeleteSets,
|
||||||
mergeDeleteSets,
|
|
||||||
snapshotContainsUpdate
|
snapshotContainsUpdate
|
||||||
} from './internals.js'
|
} from './internals.js'
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
export * from './utils/AbstractConnector.js'
|
export * from './utils/AbstractConnector.js'
|
||||||
export * from './utils/DeleteSet.js'
|
export * from './utils/DeleteSet.js'
|
||||||
export * from './utils/Doc.js'
|
export * from './utils/Doc.js'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
UpdateEncoderV1, UpdateEncoderV2, ID, Transaction // eslint-disable-line
|
UpdateEncoderV1, UpdateEncoderV2, ID, Transaction // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
@ -26,7 +27,7 @@ export class AbstractStruct {
|
|||||||
* This method is already assuming that `this.id.clock + this.length === this.id.clock`.
|
* This method is already assuming that `this.id.clock + this.length === this.id.clock`.
|
||||||
* Also this method does *not* remove right from StructStore!
|
* Also this method does *not* remove right from StructStore!
|
||||||
* @param {AbstractStruct} right
|
* @param {AbstractStruct} right
|
||||||
* @return {boolean} whether this merged with right
|
* @return {boolean} wether this merged with right
|
||||||
*/
|
*/
|
||||||
mergeWith (right) {
|
mergeWith (right) {
|
||||||
return false
|
return false
|
||||||
|
@ -2,11 +2,6 @@ import {
|
|||||||
UpdateEncoderV1, UpdateEncoderV2, UpdateDecoderV1, UpdateDecoderV2, Transaction, Item, StructStore // eslint-disable-line
|
UpdateEncoderV1, UpdateEncoderV2, UpdateDecoderV1, UpdateDecoderV2, Transaction, Item, StructStore // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
import * as env from 'lib0/environment'
|
|
||||||
import * as object from 'lib0/object'
|
|
||||||
|
|
||||||
const isDevMode = env.getVariable('node_env') === 'development'
|
|
||||||
|
|
||||||
export class ContentAny {
|
export class ContentAny {
|
||||||
/**
|
/**
|
||||||
* @param {Array<any>} arr
|
* @param {Array<any>} arr
|
||||||
@ -16,7 +11,6 @@ export class ContentAny {
|
|||||||
* @type {Array<any>}
|
* @type {Array<any>}
|
||||||
*/
|
*/
|
||||||
this.arr = arr
|
this.arr = arr
|
||||||
isDevMode && object.deepFreeze(arr)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
addToDeleteSet,
|
addToDeleteSet,
|
||||||
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Item, Transaction // eslint-disable-line
|
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Item, Transaction // eslint-disable-line
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
Doc, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction, Item // eslint-disable-line
|
Doc, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction, Item // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Item, Transaction // eslint-disable-line
|
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, StructStore, Item, Transaction // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
YText, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Item, StructStore, Transaction // eslint-disable-line
|
YText, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Item, StructStore, Transaction // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
readYArray,
|
readYArray,
|
||||||
readYMap,
|
readYMap,
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
AbstractStruct,
|
AbstractStruct,
|
||||||
addStruct,
|
addStruct,
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
GC,
|
GC,
|
||||||
getState,
|
getState,
|
||||||
@ -393,7 +394,8 @@ export class Item extends AbstractStruct {
|
|||||||
if (this.left && this.left.constructor === Item) {
|
if (this.left && this.left.constructor === Item) {
|
||||||
this.parent = this.left.parent
|
this.parent = this.left.parent
|
||||||
this.parentSub = this.left.parentSub
|
this.parentSub = this.left.parentSub
|
||||||
} else if (this.right && this.right.constructor === Item) {
|
}
|
||||||
|
if (this.right && this.right.constructor === Item) {
|
||||||
this.parent = this.right.parent
|
this.parent = this.right.parent
|
||||||
this.parentSub = this.right.parentSub
|
this.parentSub = this.right.parentSub
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
AbstractStruct,
|
AbstractStruct,
|
||||||
UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction, ID // eslint-disable-line
|
UpdateEncoderV1, UpdateEncoderV2, StructStore, Transaction, ID // eslint-disable-line
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
removeEventHandlerListener,
|
removeEventHandlerListener,
|
||||||
callEventHandlerListeners,
|
callEventHandlerListeners,
|
||||||
@ -17,12 +18,6 @@ import * as map from 'lib0/map'
|
|||||||
import * as iterator from 'lib0/iterator'
|
import * as iterator from 'lib0/iterator'
|
||||||
import * as error from 'lib0/error'
|
import * as error from 'lib0/error'
|
||||||
import * as math from 'lib0/math'
|
import * as math from 'lib0/math'
|
||||||
import * as log from 'lib0/logging'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* https://docs.yjs.dev/getting-started/working-with-shared-types#caveats
|
|
||||||
*/
|
|
||||||
export const warnPrematureAccess = () => { log.warn('Invalid access: Add Yjs type to a document before reading data.') }
|
|
||||||
|
|
||||||
const maxSearchMarker = 80
|
const maxSearchMarker = 80
|
||||||
|
|
||||||
@ -155,11 +150,11 @@ export const findMarker = (yarray, index) => {
|
|||||||
// }
|
// }
|
||||||
// }
|
// }
|
||||||
// if (marker) {
|
// if (marker) {
|
||||||
// if (window.lengths == null) {
|
// if (window.lengthes == null) {
|
||||||
// window.lengths = []
|
// window.lengthes = []
|
||||||
// window.getLengths = () => window.lengths.sort((a, b) => a - b)
|
// window.getLengthes = () => window.lengthes.sort((a, b) => a - b)
|
||||||
// }
|
// }
|
||||||
// window.lengths.push(marker.index - pindex)
|
// window.lengthes.push(marker.index - pindex)
|
||||||
// console.log('distance', marker.index - pindex, 'len', p && p.parent.length)
|
// console.log('distance', marker.index - pindex, 'len', p && p.parent.length)
|
||||||
// }
|
// }
|
||||||
if (marker !== null && math.abs(marker.index - pindex) < /** @type {YText|YArray<any>} */ (p.parent).length / maxSearchMarker) {
|
if (marker !== null && math.abs(marker.index - pindex) < /** @type {YText|YArray<any>} */ (p.parent).length / maxSearchMarker) {
|
||||||
@ -221,7 +216,6 @@ export const updateMarkerChanges = (searchMarker, index, len) => {
|
|||||||
* @return {Array<Item>}
|
* @return {Array<Item>}
|
||||||
*/
|
*/
|
||||||
export const getTypeChildren = t => {
|
export const getTypeChildren = t => {
|
||||||
t.doc ?? warnPrematureAccess()
|
|
||||||
let s = t._start
|
let s = t._start
|
||||||
const arr = []
|
const arr = []
|
||||||
while (s) {
|
while (s) {
|
||||||
@ -323,10 +317,6 @@ export class AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {AbstractType<EventType>}
|
* @return {AbstractType<EventType>}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -415,7 +405,6 @@ export class AbstractType {
|
|||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const typeListSlice = (type, start, end) => {
|
export const typeListSlice = (type, start, end) => {
|
||||||
type.doc ?? warnPrematureAccess()
|
|
||||||
if (start < 0) {
|
if (start < 0) {
|
||||||
start = type._length + start
|
start = type._length + start
|
||||||
}
|
}
|
||||||
@ -451,7 +440,6 @@ export const typeListSlice = (type, start, end) => {
|
|||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const typeListToArray = type => {
|
export const typeListToArray = type => {
|
||||||
type.doc ?? warnPrematureAccess()
|
|
||||||
const cs = []
|
const cs = []
|
||||||
let n = type._start
|
let n = type._start
|
||||||
while (n !== null) {
|
while (n !== null) {
|
||||||
@ -490,7 +478,7 @@ export const typeListToArraySnapshot = (type, snapshot) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes a provided function on once on every element of this YArray.
|
* Executes a provided function on once on overy element of this YArray.
|
||||||
*
|
*
|
||||||
* @param {AbstractType<any>} type
|
* @param {AbstractType<any>} type
|
||||||
* @param {function(any,number,any):void} f A function to execute on every element of this YArray.
|
* @param {function(any,number,any):void} f A function to execute on every element of this YArray.
|
||||||
@ -501,7 +489,6 @@ export const typeListToArraySnapshot = (type, snapshot) => {
|
|||||||
export const typeListForEach = (type, f) => {
|
export const typeListForEach = (type, f) => {
|
||||||
let index = 0
|
let index = 0
|
||||||
let n = type._start
|
let n = type._start
|
||||||
type.doc ?? warnPrematureAccess()
|
|
||||||
while (n !== null) {
|
while (n !== null) {
|
||||||
if (n.countable && !n.deleted) {
|
if (n.countable && !n.deleted) {
|
||||||
const c = n.content.getContent()
|
const c = n.content.getContent()
|
||||||
@ -583,7 +570,7 @@ export const typeListCreateIterator = type => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes a provided function on once on every element of this YArray.
|
* Executes a provided function on once on overy element of this YArray.
|
||||||
* Operates on a snapshotted state of the document.
|
* Operates on a snapshotted state of the document.
|
||||||
*
|
*
|
||||||
* @param {AbstractType<any>} type
|
* @param {AbstractType<any>} type
|
||||||
@ -616,7 +603,6 @@ export const typeListForEachSnapshot = (type, f, snapshot) => {
|
|||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const typeListGet = (type, index) => {
|
export const typeListGet = (type, index) => {
|
||||||
type.doc ?? warnPrematureAccess()
|
|
||||||
const marker = findMarker(type, index)
|
const marker = findMarker(type, index)
|
||||||
let n = type._start
|
let n = type._start
|
||||||
if (marker !== null) {
|
if (marker !== null) {
|
||||||
@ -751,7 +737,7 @@ export const typeListInsertGenerics = (transaction, parent, index, content) => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Pushing content is special as we generally want to push after the last item. So we don't have to update
|
* Pushing content is special as we generally want to push after the last item. So we don't have to update
|
||||||
* the search marker.
|
* the serach marker.
|
||||||
*
|
*
|
||||||
* @param {Transaction} transaction
|
* @param {Transaction} transaction
|
||||||
* @param {AbstractType<any>} parent
|
* @param {AbstractType<any>} parent
|
||||||
@ -885,7 +871,6 @@ export const typeMapSet = (transaction, parent, key, value) => {
|
|||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const typeMapGet = (parent, key) => {
|
export const typeMapGet = (parent, key) => {
|
||||||
parent.doc ?? warnPrematureAccess()
|
|
||||||
const val = parent._map.get(key)
|
const val = parent._map.get(key)
|
||||||
return val !== undefined && !val.deleted ? val.content.getContent()[val.length - 1] : undefined
|
return val !== undefined && !val.deleted ? val.content.getContent()[val.length - 1] : undefined
|
||||||
}
|
}
|
||||||
@ -902,7 +887,6 @@ export const typeMapGetAll = (parent) => {
|
|||||||
* @type {Object<string,any>}
|
* @type {Object<string,any>}
|
||||||
*/
|
*/
|
||||||
const res = {}
|
const res = {}
|
||||||
parent.doc ?? warnPrematureAccess()
|
|
||||||
parent._map.forEach((value, key) => {
|
parent._map.forEach((value, key) => {
|
||||||
if (!value.deleted) {
|
if (!value.deleted) {
|
||||||
res[key] = value.content.getContent()[value.length - 1]
|
res[key] = value.content.getContent()[value.length - 1]
|
||||||
@ -920,7 +904,6 @@ export const typeMapGetAll = (parent) => {
|
|||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const typeMapHas = (parent, key) => {
|
export const typeMapHas = (parent, key) => {
|
||||||
parent.doc ?? warnPrematureAccess()
|
|
||||||
const val = parent._map.get(key)
|
const val = parent._map.get(key)
|
||||||
return val !== undefined && !val.deleted
|
return val !== undefined && !val.deleted
|
||||||
}
|
}
|
||||||
@ -943,41 +926,10 @@ export const typeMapGetSnapshot = (parent, key, snapshot) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {AbstractType<any>} parent
|
* @param {Map<string,Item>} map
|
||||||
* @param {Snapshot} snapshot
|
|
||||||
* @return {Object<string,Object<string,any>|number|null|Array<any>|string|Uint8Array|AbstractType<any>|undefined>}
|
|
||||||
*
|
|
||||||
* @private
|
|
||||||
* @function
|
|
||||||
*/
|
|
||||||
export const typeMapGetAllSnapshot = (parent, snapshot) => {
|
|
||||||
/**
|
|
||||||
* @type {Object<string,any>}
|
|
||||||
*/
|
|
||||||
const res = {}
|
|
||||||
parent._map.forEach((value, key) => {
|
|
||||||
/**
|
|
||||||
* @type {Item|null}
|
|
||||||
*/
|
|
||||||
let v = value
|
|
||||||
while (v !== null && (!snapshot.sv.has(v.id.client) || v.id.clock >= (snapshot.sv.get(v.id.client) || 0))) {
|
|
||||||
v = v.left
|
|
||||||
}
|
|
||||||
if (v !== null && isVisible(v, snapshot)) {
|
|
||||||
res[key] = v.content.getContent()[v.length - 1]
|
|
||||||
}
|
|
||||||
})
|
|
||||||
return res
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {AbstractType<any> & { _map: Map<string, Item> }} type
|
|
||||||
* @return {IterableIterator<Array<any>>}
|
* @return {IterableIterator<Array<any>>}
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const createMapIterator = type => {
|
export const createMapIterator = map => iterator.iteratorFilter(map.entries(), /** @param {any} entry */ entry => !entry[1].deleted)
|
||||||
type.doc ?? warnPrematureAccess()
|
|
||||||
return iterator.iteratorFilter(type._map.entries(), /** @param {any} entry */ entry => !entry[1].deleted)
|
|
||||||
}
|
|
||||||
|
@ -16,7 +16,6 @@ import {
|
|||||||
YArrayRefID,
|
YArrayRefID,
|
||||||
callTypeObservers,
|
callTypeObservers,
|
||||||
transact,
|
transact,
|
||||||
warnPrematureAccess,
|
|
||||||
ArraySearchMarker, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Transaction, Item // eslint-disable-line
|
ArraySearchMarker, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Transaction, Item // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
import { typeListSlice } from './AbstractType.js'
|
import { typeListSlice } from './AbstractType.js'
|
||||||
@ -26,7 +25,16 @@ import { typeListSlice } from './AbstractType.js'
|
|||||||
* @template T
|
* @template T
|
||||||
* @extends YEvent<YArray<T>>
|
* @extends YEvent<YArray<T>>
|
||||||
*/
|
*/
|
||||||
export class YArrayEvent extends YEvent {}
|
export class YArrayEvent extends YEvent {
|
||||||
|
/**
|
||||||
|
* @param {YArray<T>} yarray The changed type
|
||||||
|
* @param {Transaction} transaction The transaction object
|
||||||
|
*/
|
||||||
|
constructor (yarray, transaction) {
|
||||||
|
super(yarray, transaction)
|
||||||
|
this._transaction = transaction
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A shared Array implementation.
|
* A shared Array implementation.
|
||||||
@ -87,10 +95,6 @@ export class YArray extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YArray<T>}
|
* @return {YArray<T>}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -105,8 +109,7 @@ export class YArray extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get length () {
|
get length () {
|
||||||
this.doc ?? warnPrematureAccess()
|
return this._prelimContent === null ? this._length : this._prelimContent.length
|
||||||
return this._length
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -164,9 +167,9 @@ export class YArray extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepends content to this YArray.
|
* Preppends content to this YArray.
|
||||||
*
|
*
|
||||||
* @param {Array<T>} content Array of content to prepend.
|
* @param {Array<T>} content Array of content to preppend.
|
||||||
*/
|
*/
|
||||||
unshift (content) {
|
unshift (content) {
|
||||||
this.insert(0, content)
|
this.insert(0, content)
|
||||||
@ -208,8 +211,7 @@ export class YArray extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a portion of this YArray into a JavaScript Array selected
|
* Transforms this YArray to a JavaScript Array.
|
||||||
* from start to end (end not included).
|
|
||||||
*
|
*
|
||||||
* @param {number} [start]
|
* @param {number} [start]
|
||||||
* @param {number} [end]
|
* @param {number} [end]
|
||||||
@ -242,7 +244,7 @@ export class YArray extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes a provided function once on every element of this YArray.
|
* Executes a provided function once on overy element of this YArray.
|
||||||
*
|
*
|
||||||
* @param {function(T,number,YArray<T>):void} f A function to execute on every element of this YArray.
|
* @param {function(T,number,YArray<T>):void} f A function to execute on every element of this YArray.
|
||||||
*/
|
*/
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module YMap
|
* @module YMap
|
||||||
*/
|
*/
|
||||||
@ -13,7 +14,6 @@ import {
|
|||||||
YMapRefID,
|
YMapRefID,
|
||||||
callTypeObservers,
|
callTypeObservers,
|
||||||
transact,
|
transact,
|
||||||
warnPrematureAccess,
|
|
||||||
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Transaction, Item // eslint-disable-line
|
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Transaction, Item // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
@ -89,10 +89,6 @@ export class YMap extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YMap<MapType>}
|
* @return {YMap<MapType>}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -122,7 +118,6 @@ export class YMap extends AbstractType {
|
|||||||
* @return {Object<string,any>}
|
* @return {Object<string,any>}
|
||||||
*/
|
*/
|
||||||
toJSON () {
|
toJSON () {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
/**
|
/**
|
||||||
* @type {Object<string,MapType>}
|
* @type {Object<string,MapType>}
|
||||||
*/
|
*/
|
||||||
@ -142,7 +137,7 @@ export class YMap extends AbstractType {
|
|||||||
* @return {number}
|
* @return {number}
|
||||||
*/
|
*/
|
||||||
get size () {
|
get size () {
|
||||||
return [...createMapIterator(this)].length
|
return [...createMapIterator(this._map)].length
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -151,7 +146,7 @@ export class YMap extends AbstractType {
|
|||||||
* @return {IterableIterator<string>}
|
* @return {IterableIterator<string>}
|
||||||
*/
|
*/
|
||||||
keys () {
|
keys () {
|
||||||
return iterator.iteratorMap(createMapIterator(this), /** @param {any} v */ v => v[0])
|
return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => v[0])
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -160,7 +155,7 @@ export class YMap extends AbstractType {
|
|||||||
* @return {IterableIterator<MapType>}
|
* @return {IterableIterator<MapType>}
|
||||||
*/
|
*/
|
||||||
values () {
|
values () {
|
||||||
return iterator.iteratorMap(createMapIterator(this), /** @param {any} v */ v => v[1].content.getContent()[v[1].length - 1])
|
return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => v[1].content.getContent()[v[1].length - 1])
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -169,7 +164,7 @@ export class YMap extends AbstractType {
|
|||||||
* @return {IterableIterator<[string, MapType]>}
|
* @return {IterableIterator<[string, MapType]>}
|
||||||
*/
|
*/
|
||||||
entries () {
|
entries () {
|
||||||
return iterator.iteratorMap(createMapIterator(this), /** @param {any} v */ v => /** @type {any} */ ([v[0], v[1].content.getContent()[v[1].length - 1]]))
|
return iterator.iteratorMap(createMapIterator(this._map), /** @param {any} v */ v => /** @type {any} */ ([v[0], v[1].content.getContent()[v[1].length - 1]]))
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -178,7 +173,6 @@ export class YMap extends AbstractType {
|
|||||||
* @param {function(MapType,string,YMap<MapType>):void} f A function to execute on every element of this YArray.
|
* @param {function(MapType,string,YMap<MapType>):void} f A function to execute on every element of this YArray.
|
||||||
*/
|
*/
|
||||||
forEach (f) {
|
forEach (f) {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
this._map.forEach((item, key) => {
|
this._map.forEach((item, key) => {
|
||||||
if (!item.deleted) {
|
if (!item.deleted) {
|
||||||
f(item.content.getContent()[item.length - 1], key, this)
|
f(item.content.getContent()[item.length - 1], key, this)
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module YText
|
* @module YText
|
||||||
*/
|
*/
|
||||||
@ -26,7 +27,6 @@ import {
|
|||||||
typeMapGetAll,
|
typeMapGetAll,
|
||||||
updateMarkerChanges,
|
updateMarkerChanges,
|
||||||
ContentType,
|
ContentType,
|
||||||
warnPrematureAccess,
|
|
||||||
ArraySearchMarker, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, ID, Doc, Item, Snapshot, Transaction // eslint-disable-line
|
ArraySearchMarker, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, ID, Doc, Item, Snapshot, Transaction // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
@ -118,15 +118,14 @@ const findNextPosition = (transaction, pos, count) => {
|
|||||||
* @param {Transaction} transaction
|
* @param {Transaction} transaction
|
||||||
* @param {AbstractType<any>} parent
|
* @param {AbstractType<any>} parent
|
||||||
* @param {number} index
|
* @param {number} index
|
||||||
* @param {boolean} useSearchMarker
|
|
||||||
* @return {ItemTextListPosition}
|
* @return {ItemTextListPosition}
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
const findPosition = (transaction, parent, index, useSearchMarker) => {
|
const findPosition = (transaction, parent, index) => {
|
||||||
const currentAttributes = new Map()
|
const currentAttributes = new Map()
|
||||||
const marker = useSearchMarker ? findMarker(parent, index) : null
|
const marker = findMarker(parent, index)
|
||||||
if (marker) {
|
if (marker) {
|
||||||
const pos = new ItemTextListPosition(marker.p.left, marker.p, marker.index, currentAttributes)
|
const pos = new ItemTextListPosition(marker.p.left, marker.p, marker.index, currentAttributes)
|
||||||
return findNextPosition(transaction, pos, index - marker.index)
|
return findNextPosition(transaction, pos, index - marker.index)
|
||||||
@ -202,7 +201,7 @@ const minimizeAttributeChanges = (currPos, attributes) => {
|
|||||||
while (true) {
|
while (true) {
|
||||||
if (currPos.right === null) {
|
if (currPos.right === null) {
|
||||||
break
|
break
|
||||||
} else if (currPos.right.deleted || (currPos.right.content.constructor === ContentFormat && equalAttrs(attributes[(/** @type {ContentFormat} */ (currPos.right.content)).key] ?? null, /** @type {ContentFormat} */ (currPos.right.content).value))) {
|
} else if (currPos.right.deleted || (currPos.right.content.constructor === ContentFormat && equalAttrs(attributes[(/** @type {ContentFormat} */ (currPos.right.content)).key] || null, /** @type {ContentFormat} */ (currPos.right.content).value))) {
|
||||||
//
|
//
|
||||||
} else {
|
} else {
|
||||||
break
|
break
|
||||||
@ -228,7 +227,7 @@ const insertAttributes = (transaction, parent, currPos, attributes) => {
|
|||||||
// insert format-start items
|
// insert format-start items
|
||||||
for (const key in attributes) {
|
for (const key in attributes) {
|
||||||
const val = attributes[key]
|
const val = attributes[key]
|
||||||
const currentVal = currPos.currentAttributes.get(key) ?? null
|
const currentVal = currPos.currentAttributes.get(key) || null
|
||||||
if (!equalAttrs(currentVal, val)) {
|
if (!equalAttrs(currentVal, val)) {
|
||||||
// save negated attribute (set null if currentVal undefined)
|
// save negated attribute (set null if currentVal undefined)
|
||||||
negatedAttributes.set(key, currentVal)
|
negatedAttributes.set(key, currentVal)
|
||||||
@ -390,12 +389,12 @@ const cleanupFormattingGap = (transaction, start, curr, startAttributes, currAtt
|
|||||||
switch (content.constructor) {
|
switch (content.constructor) {
|
||||||
case ContentFormat: {
|
case ContentFormat: {
|
||||||
const { key, value } = /** @type {ContentFormat} */ (content)
|
const { key, value } = /** @type {ContentFormat} */ (content)
|
||||||
const startAttrValue = startAttributes.get(key) ?? null
|
const startAttrValue = startAttributes.get(key) || null
|
||||||
if (endFormats.get(key) !== content || startAttrValue === value) {
|
if (endFormats.get(key) !== content || startAttrValue === value) {
|
||||||
// Either this format is overwritten or it is not necessary because the attribute already existed.
|
// Either this format is overwritten or it is not necessary because the attribute already existed.
|
||||||
start.delete(transaction)
|
start.delete(transaction)
|
||||||
cleanups++
|
cleanups++
|
||||||
if (!reachedCurr && (currAttributes.get(key) ?? null) === value && startAttrValue !== value) {
|
if (!reachedCurr && (currAttributes.get(key) || null) === value && startAttrValue !== value) {
|
||||||
if (startAttrValue === null) {
|
if (startAttrValue === null) {
|
||||||
currAttributes.delete(key)
|
currAttributes.delete(key)
|
||||||
} else {
|
} else {
|
||||||
@ -478,7 +477,7 @@ export const cleanupYTextFormatting = type => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This will be called by the transaction once the event handlers are called to potentially cleanup
|
* This will be called by the transction once the event handlers are called to potentially cleanup
|
||||||
* formatting attributes.
|
* formatting attributes.
|
||||||
*
|
*
|
||||||
* @param {Transaction} transaction
|
* @param {Transaction} transaction
|
||||||
@ -568,7 +567,7 @@ const deleteText = (transaction, currPos, length) => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The Quill Delta format represents changes on a text document with
|
* The Quill Delta format represents changes on a text document with
|
||||||
* formatting information. For more information visit {@link https://quilljs.com/docs/delta/|Quill Delta}
|
* formatting information. For mor information visit {@link https://quilljs.com/docs/delta/|Quill Delta}
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* {
|
* {
|
||||||
@ -770,12 +769,12 @@ export class YTextEvent extends YEvent {
|
|||||||
const { key, value } = /** @type {ContentFormat} */ (item.content)
|
const { key, value } = /** @type {ContentFormat} */ (item.content)
|
||||||
if (this.adds(item)) {
|
if (this.adds(item)) {
|
||||||
if (!this.deletes(item)) {
|
if (!this.deletes(item)) {
|
||||||
const curVal = currentAttributes.get(key) ?? null
|
const curVal = currentAttributes.get(key) || null
|
||||||
if (!equalAttrs(curVal, value)) {
|
if (!equalAttrs(curVal, value)) {
|
||||||
if (action === 'retain') {
|
if (action === 'retain') {
|
||||||
addOp()
|
addOp()
|
||||||
}
|
}
|
||||||
if (equalAttrs(value, (oldAttributes.get(key) ?? null))) {
|
if (equalAttrs(value, (oldAttributes.get(key) || null))) {
|
||||||
delete attributes[key]
|
delete attributes[key]
|
||||||
} else {
|
} else {
|
||||||
attributes[key] = value
|
attributes[key] = value
|
||||||
@ -786,7 +785,7 @@ export class YTextEvent extends YEvent {
|
|||||||
}
|
}
|
||||||
} else if (this.deletes(item)) {
|
} else if (this.deletes(item)) {
|
||||||
oldAttributes.set(key, value)
|
oldAttributes.set(key, value)
|
||||||
const curVal = currentAttributes.get(key) ?? null
|
const curVal = currentAttributes.get(key) || null
|
||||||
if (!equalAttrs(curVal, value)) {
|
if (!equalAttrs(curVal, value)) {
|
||||||
if (action === 'retain') {
|
if (action === 'retain') {
|
||||||
addOp()
|
addOp()
|
||||||
@ -876,7 +875,6 @@ export class YText extends AbstractType {
|
|||||||
* @type {number}
|
* @type {number}
|
||||||
*/
|
*/
|
||||||
get length () {
|
get length () {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
return this._length
|
return this._length
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -899,10 +897,6 @@ export class YText extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YText}
|
* @return {YText}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -933,7 +927,6 @@ export class YText extends AbstractType {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
toString () {
|
toString () {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
let str = ''
|
let str = ''
|
||||||
/**
|
/**
|
||||||
* @type {Item|null}
|
* @type {Item|null}
|
||||||
@ -961,7 +954,7 @@ export class YText extends AbstractType {
|
|||||||
/**
|
/**
|
||||||
* Apply a {@link Delta} on this shared YText type.
|
* Apply a {@link Delta} on this shared YText type.
|
||||||
*
|
*
|
||||||
* @param {Array<any>} delta The changes to apply on this element.
|
* @param {any} delta The changes to apply on this element.
|
||||||
* @param {object} opts
|
* @param {object} opts
|
||||||
* @param {boolean} [opts.sanitize] Sanitize input delta. Removes ending newlines if set to true.
|
* @param {boolean} [opts.sanitize] Sanitize input delta. Removes ending newlines if set to true.
|
||||||
*
|
*
|
||||||
@ -1007,7 +1000,6 @@ export class YText extends AbstractType {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
toDelta (snapshot, prevSnapshot, computeYChange) {
|
toDelta (snapshot, prevSnapshot, computeYChange) {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
/**
|
/**
|
||||||
* @type{Array<any>}
|
* @type{Array<any>}
|
||||||
*/
|
*/
|
||||||
@ -1128,7 +1120,7 @@ export class YText extends AbstractType {
|
|||||||
const y = this.doc
|
const y = this.doc
|
||||||
if (y !== null) {
|
if (y !== null) {
|
||||||
transact(y, transaction => {
|
transact(y, transaction => {
|
||||||
const pos = findPosition(transaction, this, index, !attributes)
|
const pos = findPosition(transaction, this, index)
|
||||||
if (!attributes) {
|
if (!attributes) {
|
||||||
attributes = {}
|
attributes = {}
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@ -1146,20 +1138,20 @@ export class YText extends AbstractType {
|
|||||||
*
|
*
|
||||||
* @param {number} index The index to insert the embed at.
|
* @param {number} index The index to insert the embed at.
|
||||||
* @param {Object | AbstractType<any>} embed The Object that represents the embed.
|
* @param {Object | AbstractType<any>} embed The Object that represents the embed.
|
||||||
* @param {TextAttributes} [attributes] Attribute information to apply on the
|
* @param {TextAttributes} attributes Attribute information to apply on the
|
||||||
* embed
|
* embed
|
||||||
*
|
*
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
insertEmbed (index, embed, attributes) {
|
insertEmbed (index, embed, attributes = {}) {
|
||||||
const y = this.doc
|
const y = this.doc
|
||||||
if (y !== null) {
|
if (y !== null) {
|
||||||
transact(y, transaction => {
|
transact(y, transaction => {
|
||||||
const pos = findPosition(transaction, this, index, !attributes)
|
const pos = findPosition(transaction, this, index)
|
||||||
insertText(transaction, this, pos, embed, attributes || {})
|
insertText(transaction, this, pos, embed, attributes)
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
/** @type {Array<function>} */ (this._pending).push(() => this.insertEmbed(index, embed, attributes || {}))
|
/** @type {Array<function>} */ (this._pending).push(() => this.insertEmbed(index, embed, attributes))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1178,7 +1170,7 @@ export class YText extends AbstractType {
|
|||||||
const y = this.doc
|
const y = this.doc
|
||||||
if (y !== null) {
|
if (y !== null) {
|
||||||
transact(y, transaction => {
|
transact(y, transaction => {
|
||||||
deleteText(transaction, findPosition(transaction, this, index, true), length)
|
deleteText(transaction, findPosition(transaction, this, index), length)
|
||||||
})
|
})
|
||||||
} else {
|
} else {
|
||||||
/** @type {Array<function>} */ (this._pending).push(() => this.delete(index, length))
|
/** @type {Array<function>} */ (this._pending).push(() => this.delete(index, length))
|
||||||
@ -1202,7 +1194,7 @@ export class YText extends AbstractType {
|
|||||||
const y = this.doc
|
const y = this.doc
|
||||||
if (y !== null) {
|
if (y !== null) {
|
||||||
transact(y, transaction => {
|
transact(y, transaction => {
|
||||||
const pos = findPosition(transaction, this, index, false)
|
const pos = findPosition(transaction, this, index)
|
||||||
if (pos.right === null) {
|
if (pos.right === null) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -8,10 +8,9 @@ import {
|
|||||||
typeMapSet,
|
typeMapSet,
|
||||||
typeMapGet,
|
typeMapGet,
|
||||||
typeMapGetAll,
|
typeMapGetAll,
|
||||||
typeMapGetAllSnapshot,
|
|
||||||
typeListForEach,
|
typeListForEach,
|
||||||
YXmlElementRefID,
|
YXmlElementRefID,
|
||||||
Snapshot, YXmlText, ContentType, AbstractType, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Item // eslint-disable-line
|
YXmlText, ContentType, AbstractType, UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, Item // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -20,7 +19,7 @@ import {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* An YXmlElement imitates the behavior of a
|
* An YXmlElement imitates the behavior of a
|
||||||
* https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element
|
* {@link https://developer.mozilla.org/en-US/docs/Web/API/Element|Dom Element}.
|
||||||
*
|
*
|
||||||
* * An YXmlElement has attributes (key value pairs)
|
* * An YXmlElement has attributes (key value pairs)
|
||||||
* * An YXmlElement has childElements that must inherit from YXmlElement
|
* * An YXmlElement has childElements that must inherit from YXmlElement
|
||||||
@ -81,10 +80,6 @@ export class YXmlElement extends YXmlFragment {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YXmlElement<KV>}
|
* @return {YXmlElement<KV>}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -197,13 +192,12 @@ export class YXmlElement extends YXmlFragment {
|
|||||||
/**
|
/**
|
||||||
* Returns all attribute name/value pairs in a JSON Object.
|
* Returns all attribute name/value pairs in a JSON Object.
|
||||||
*
|
*
|
||||||
* @param {Snapshot} [snapshot]
|
|
||||||
* @return {{ [Key in Extract<keyof KV,string>]?: KV[Key]}} A JSON Object that describes the attributes.
|
* @return {{ [Key in Extract<keyof KV,string>]?: KV[Key]}} A JSON Object that describes the attributes.
|
||||||
*
|
*
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
getAttributes (snapshot) {
|
getAttributes () {
|
||||||
return /** @type {any} */ (snapshot ? typeMapGetAllSnapshot(this, snapshot) : typeMapGetAll(this))
|
return /** @type {any} */ (typeMapGetAll(this))
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
YEvent,
|
YEvent,
|
||||||
YXmlText, YXmlElement, YXmlFragment, Transaction // eslint-disable-line
|
YXmlText, YXmlElement, YXmlFragment, Transaction // eslint-disable-line
|
||||||
@ -12,7 +13,7 @@ export class YXmlEvent extends YEvent {
|
|||||||
* @param {YXmlElement|YXmlText|YXmlFragment} target The target on which the event is created.
|
* @param {YXmlElement|YXmlText|YXmlFragment} target The target on which the event is created.
|
||||||
* @param {Set<string|null>} subs The set of changed attributes. `null` is included if the
|
* @param {Set<string|null>} subs The set of changed attributes. `null` is included if the
|
||||||
* child list changed.
|
* child list changed.
|
||||||
* @param {Transaction} transaction The transaction instance with which the
|
* @param {Transaction} transaction The transaction instance with wich the
|
||||||
* change was created.
|
* change was created.
|
||||||
*/
|
*/
|
||||||
constructor (target, subs, transaction) {
|
constructor (target, subs, transaction) {
|
||||||
|
@ -17,7 +17,6 @@ import {
|
|||||||
transact,
|
transact,
|
||||||
typeListGet,
|
typeListGet,
|
||||||
typeListSlice,
|
typeListSlice,
|
||||||
warnPrematureAccess,
|
|
||||||
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, ContentType, Transaction, Item, YXmlText, YXmlHook // eslint-disable-line
|
UpdateDecoderV1, UpdateDecoderV2, UpdateEncoderV1, UpdateEncoderV2, Doc, ContentType, Transaction, Item, YXmlText, YXmlHook // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
@ -67,7 +66,6 @@ export class YXmlTreeWalker {
|
|||||||
*/
|
*/
|
||||||
this._currentNode = /** @type {Item} */ (root._start)
|
this._currentNode = /** @type {Item} */ (root._start)
|
||||||
this._firstCall = true
|
this._firstCall = true
|
||||||
root.doc ?? warnPrematureAccess()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
[Symbol.iterator] () {
|
[Symbol.iterator] () {
|
||||||
@ -96,12 +94,8 @@ export class YXmlTreeWalker {
|
|||||||
} else {
|
} else {
|
||||||
// walk right or up in the tree
|
// walk right or up in the tree
|
||||||
while (n !== null) {
|
while (n !== null) {
|
||||||
/**
|
if (n.right !== null) {
|
||||||
* @type {Item | null}
|
n = n.right
|
||||||
*/
|
|
||||||
const nxt = n.next
|
|
||||||
if (nxt !== null) {
|
|
||||||
n = nxt
|
|
||||||
break
|
break
|
||||||
} else if (n.parent === this._root) {
|
} else if (n.parent === this._root) {
|
||||||
n = null
|
n = null
|
||||||
@ -169,10 +163,6 @@ export class YXmlFragment extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YXmlFragment}
|
* @return {YXmlFragment}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
@ -183,7 +173,6 @@ export class YXmlFragment extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get length () {
|
get length () {
|
||||||
this.doc ?? warnPrematureAccess()
|
|
||||||
return this._prelimContent === null ? this._length : this._prelimContent.length
|
return this._prelimContent === null ? this._length : this._prelimContent.length
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -387,9 +376,9 @@ export class YXmlFragment extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepends content to this YArray.
|
* Preppends content to this YArray.
|
||||||
*
|
*
|
||||||
* @param {Array<YXmlElement|YXmlText>} content Array of content to prepend.
|
* @param {Array<YXmlElement|YXmlText>} content Array of content to preppend.
|
||||||
*/
|
*/
|
||||||
unshift (content) {
|
unshift (content) {
|
||||||
this.insert(0, content)
|
this.insert(0, content)
|
||||||
@ -406,8 +395,7 @@ export class YXmlFragment extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a portion of this YXmlFragment into a JavaScript Array selected
|
* Transforms this YArray to a JavaScript Array.
|
||||||
* from start to end (end not included).
|
|
||||||
*
|
*
|
||||||
* @param {number} [start]
|
* @param {number} [start]
|
||||||
* @param {number} [end]
|
* @param {number} [end]
|
||||||
@ -418,7 +406,7 @@ export class YXmlFragment extends AbstractType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Executes a provided function on once on every child element.
|
* Executes a provided function on once on overy child element.
|
||||||
*
|
*
|
||||||
* @param {function(YXmlElement|YXmlText,number, typeof self):void} f A function to execute on every element of this YArray.
|
* @param {function(YXmlElement|YXmlText,number, typeof self):void} f A function to execute on every element of this YArray.
|
||||||
*/
|
*/
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
YMap,
|
YMap,
|
||||||
YXmlHookRefID,
|
YXmlHookRefID,
|
||||||
@ -29,10 +30,6 @@ export class YXmlHook extends YMap {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YXmlHook}
|
* @return {YXmlHook}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
YText,
|
YText,
|
||||||
YXmlTextRefID,
|
YXmlTextRefID,
|
||||||
@ -30,10 +31,6 @@ export class YXmlText extends YText {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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 {YXmlText}
|
* @return {YXmlText}
|
||||||
*/
|
*/
|
||||||
clone () {
|
clone () {
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import { ObservableV2 } from 'lib0/observable'
|
|
||||||
|
import { Observable } from 'lib0/observable'
|
||||||
|
|
||||||
import {
|
import {
|
||||||
Doc // eslint-disable-line
|
Doc // eslint-disable-line
|
||||||
@ -10,9 +11,9 @@ import {
|
|||||||
* @note This interface is experimental and it is not advised to actually inherit this class.
|
* @note This interface is experimental and it is not advised to actually inherit this class.
|
||||||
* It just serves as typing information.
|
* It just serves as typing information.
|
||||||
*
|
*
|
||||||
* @extends {ObservableV2<any>}
|
* @extends {Observable<any>}
|
||||||
*/
|
*/
|
||||||
export class AbstractConnector extends ObservableV2 {
|
export class AbstractConnector extends Observable {
|
||||||
/**
|
/**
|
||||||
* @param {Doc} ydoc
|
* @param {Doc} ydoc
|
||||||
* @param {any} awareness
|
* @param {any} awareness
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
findIndexSS,
|
findIndexSS,
|
||||||
getState,
|
getState,
|
||||||
|
@ -8,13 +8,12 @@ import {
|
|||||||
YArray,
|
YArray,
|
||||||
YText,
|
YText,
|
||||||
YMap,
|
YMap,
|
||||||
YXmlElement,
|
|
||||||
YXmlFragment,
|
YXmlFragment,
|
||||||
transact,
|
transact,
|
||||||
ContentDoc, Item, Transaction, YEvent // eslint-disable-line
|
ContentDoc, Item, Transaction, YEvent // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
import { ObservableV2 } from 'lib0/observable'
|
import { Observable } from 'lib0/observable'
|
||||||
import * as random from 'lib0/random'
|
import * as random from 'lib0/random'
|
||||||
import * as map from 'lib0/map'
|
import * as map from 'lib0/map'
|
||||||
import * as array from 'lib0/array'
|
import * as array from 'lib0/array'
|
||||||
@ -33,27 +32,11 @@ export const generateNewClientId = random.uint32
|
|||||||
* @property {boolean} [DocOpts.shouldLoad] Whether the document should be synced by the provider now. This is toggled to true when you call ydoc.load()
|
* @property {boolean} [DocOpts.shouldLoad] Whether the document should be synced by the provider now. This is toggled to true when you call ydoc.load()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
|
||||||
* @typedef {Object} DocEvents
|
|
||||||
* @property {function(Doc):void} DocEvents.destroy
|
|
||||||
* @property {function(Doc):void} DocEvents.load
|
|
||||||
* @property {function(boolean, Doc):void} DocEvents.sync
|
|
||||||
* @property {function(Uint8Array, any, Doc, Transaction):void} DocEvents.update
|
|
||||||
* @property {function(Uint8Array, any, Doc, Transaction):void} DocEvents.updateV2
|
|
||||||
* @property {function(Doc):void} DocEvents.beforeAllTransactions
|
|
||||||
* @property {function(Transaction, Doc):void} DocEvents.beforeTransaction
|
|
||||||
* @property {function(Transaction, Doc):void} DocEvents.beforeObserverCalls
|
|
||||||
* @property {function(Transaction, Doc):void} DocEvents.afterTransaction
|
|
||||||
* @property {function(Transaction, Doc):void} DocEvents.afterTransactionCleanup
|
|
||||||
* @property {function(Doc, Array<Transaction>):void} DocEvents.afterAllTransactions
|
|
||||||
* @property {function({ loaded: Set<Doc>, added: Set<Doc>, removed: Set<Doc> }, Doc, Transaction):void} DocEvents.subdocs
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A Yjs instance handles the state of shared data.
|
* A Yjs instance handles the state of shared data.
|
||||||
* @extends ObservableV2<DocEvents>
|
* @extends Observable<string>
|
||||||
*/
|
*/
|
||||||
export class Doc extends ObservableV2 {
|
export class Doc extends Observable {
|
||||||
/**
|
/**
|
||||||
* @param {DocOpts} opts configuration
|
* @param {DocOpts} opts configuration
|
||||||
*/
|
*/
|
||||||
@ -104,9 +87,8 @@ export class Doc extends ObservableV2 {
|
|||||||
* lost (with false as a parameter).
|
* lost (with false as a parameter).
|
||||||
*/
|
*/
|
||||||
this.isSynced = false
|
this.isSynced = false
|
||||||
this.isDestroyed = false
|
|
||||||
/**
|
/**
|
||||||
* Promise that resolves once the document has been loaded from a persistence provider.
|
* Promise that resolves once the document has been loaded from a presistence provider.
|
||||||
*/
|
*/
|
||||||
this.whenLoaded = promise.create(resolve => {
|
this.whenLoaded = promise.create(resolve => {
|
||||||
this.on('load', () => {
|
this.on('load', () => {
|
||||||
@ -132,7 +114,7 @@ export class Doc extends ObservableV2 {
|
|||||||
}
|
}
|
||||||
this.isSynced = isSynced === undefined || isSynced === true
|
this.isSynced = isSynced === undefined || isSynced === true
|
||||||
if (this.isSynced && !this.isLoaded) {
|
if (this.isSynced && !this.isLoaded) {
|
||||||
this.emit('load', [this])
|
this.emit('load', [])
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
/**
|
/**
|
||||||
@ -188,31 +170,30 @@ export class Doc extends ObservableV2 {
|
|||||||
/**
|
/**
|
||||||
* Define a shared data type.
|
* Define a shared data type.
|
||||||
*
|
*
|
||||||
* Multiple calls of `ydoc.get(name, TypeConstructor)` yield the same result
|
* Multiple calls of `y.get(name, TypeConstructor)` yield the same result
|
||||||
* and do not overwrite each other. I.e.
|
* and do not overwrite each other. I.e.
|
||||||
* `ydoc.get(name, Y.Array) === ydoc.get(name, Y.Array)`
|
* `y.define(name, Y.Array) === y.define(name, Y.Array)`
|
||||||
*
|
*
|
||||||
* After this method is called, the type is also available on `ydoc.share.get(name)`.
|
* After this method is called, the type is also available on `y.share.get(name)`.
|
||||||
*
|
*
|
||||||
* *Best Practices:*
|
* *Best Practices:*
|
||||||
* Define all types right after the Y.Doc instance is created and store them in a separate object.
|
* Define all types right after the Yjs instance is created and store them in a separate object.
|
||||||
* Also use the typed methods `getText(name)`, `getArray(name)`, ..
|
* Also use the typed methods `getText(name)`, `getArray(name)`, ..
|
||||||
*
|
*
|
||||||
* @template {typeof AbstractType<any>} Type
|
|
||||||
* @example
|
* @example
|
||||||
* const ydoc = new Y.Doc(..)
|
* const y = new Y(..)
|
||||||
* const appState = {
|
* const appState = {
|
||||||
* document: ydoc.getText('document')
|
* document: y.getText('document')
|
||||||
* comments: ydoc.getArray('comments')
|
* comments: y.getArray('comments')
|
||||||
* }
|
* }
|
||||||
*
|
*
|
||||||
* @param {string} name
|
* @param {string} name
|
||||||
* @param {Type} TypeConstructor The constructor of the type definition. E.g. Y.Text, Y.Array, Y.Map, ...
|
* @param {Function} TypeConstructor The constructor of the type definition. E.g. Y.Text, Y.Array, Y.Map, ...
|
||||||
* @return {InstanceType<Type>} The created type. Constructed with TypeConstructor
|
* @return {AbstractType<any>} The created type. Constructed with TypeConstructor
|
||||||
*
|
*
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
get (name, TypeConstructor = /** @type {any} */ (AbstractType)) {
|
get (name, TypeConstructor = AbstractType) {
|
||||||
const type = map.setIfUndefined(this.share, name, () => {
|
const type = map.setIfUndefined(this.share, name, () => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
const t = new TypeConstructor()
|
const t = new TypeConstructor()
|
||||||
@ -238,12 +219,12 @@ export class Doc extends ObservableV2 {
|
|||||||
t._length = type._length
|
t._length = type._length
|
||||||
this.share.set(name, t)
|
this.share.set(name, t)
|
||||||
t._integrate(this, null)
|
t._integrate(this, null)
|
||||||
return /** @type {InstanceType<Type>} */ (t)
|
return t
|
||||||
} else {
|
} else {
|
||||||
throw new Error(`Type with the name ${name} has already been defined with a different constructor`)
|
throw new Error(`Type with the name ${name} has already been defined with a different constructor`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return /** @type {InstanceType<Type>} */ (type)
|
return type
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -254,7 +235,8 @@ export class Doc extends ObservableV2 {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
getArray (name = '') {
|
getArray (name = '') {
|
||||||
return /** @type {YArray<T>} */ (this.get(name, YArray))
|
// @ts-ignore
|
||||||
|
return this.get(name, YArray)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -264,6 +246,7 @@ export class Doc extends ObservableV2 {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
getText (name = '') {
|
getText (name = '') {
|
||||||
|
// @ts-ignore
|
||||||
return this.get(name, YText)
|
return this.get(name, YText)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -275,17 +258,8 @@ export class Doc extends ObservableV2 {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
getMap (name = '') {
|
getMap (name = '') {
|
||||||
return /** @type {YMap<T>} */ (this.get(name, YMap))
|
// @ts-ignore
|
||||||
}
|
return this.get(name, YMap)
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} [name]
|
|
||||||
* @return {YXmlElement}
|
|
||||||
*
|
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
getXmlElement (name = '') {
|
|
||||||
return /** @type {YXmlElement<{[key:string]:string}>} */ (this.get(name, YXmlElement))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -295,6 +269,7 @@ export class Doc extends ObservableV2 {
|
|||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
getXmlFragment (name = '') {
|
getXmlFragment (name = '') {
|
||||||
|
// @ts-ignore
|
||||||
return this.get(name, YXmlFragment)
|
return this.get(name, YXmlFragment)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -323,7 +298,6 @@ export class Doc extends ObservableV2 {
|
|||||||
* Emit `destroy` event and unregister all event handlers.
|
* Emit `destroy` event and unregister all event handlers.
|
||||||
*/
|
*/
|
||||||
destroy () {
|
destroy () {
|
||||||
this.isDestroyed = true
|
|
||||||
array.from(this.subdocs).forEach(subdoc => subdoc.destroy())
|
array.from(this.subdocs).forEach(subdoc => subdoc.destroy())
|
||||||
const item = this._item
|
const item = this._item
|
||||||
if (item !== null) {
|
if (item !== null) {
|
||||||
@ -339,9 +313,24 @@ export class Doc extends ObservableV2 {
|
|||||||
transaction.subdocsRemoved.add(this)
|
transaction.subdocsRemoved.add(this)
|
||||||
}, null, true)
|
}, null, true)
|
||||||
}
|
}
|
||||||
// @ts-ignore
|
this.emit('destroyed', [true])
|
||||||
this.emit('destroyed', [true]) // DEPRECATED!
|
|
||||||
this.emit('destroy', [this])
|
this.emit('destroy', [this])
|
||||||
super.destroy()
|
super.destroy()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} eventName
|
||||||
|
* @param {function(...any):any} f
|
||||||
|
*/
|
||||||
|
on (eventName, f) {
|
||||||
|
super.on(eventName, f)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} eventName
|
||||||
|
* @param {function} f
|
||||||
|
*/
|
||||||
|
off (eventName, f) {
|
||||||
|
super.off(eventName, f)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import { AbstractType } from '../internals.js' // eslint-disable-line
|
import { AbstractType } from '../internals.js' // eslint-disable-line
|
||||||
|
|
||||||
import * as decoding from 'lib0/decoding'
|
import * as decoding from 'lib0/decoding'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
YArray,
|
YArray,
|
||||||
YMap,
|
YMap,
|
||||||
@ -62,7 +63,7 @@ export class PermanentUserData {
|
|||||||
initUser(storeType.get(userDescription), userDescription)
|
initUser(storeType.get(userDescription), userDescription)
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
// add initial data
|
// add intial data
|
||||||
storeType.forEach(initUser)
|
storeType.forEach(initUser)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
writeID,
|
writeID,
|
||||||
readID,
|
readID,
|
||||||
@ -8,8 +9,7 @@ import {
|
|||||||
createID,
|
createID,
|
||||||
ContentType,
|
ContentType,
|
||||||
followRedone,
|
followRedone,
|
||||||
getItem,
|
ID, Doc, AbstractType // eslint-disable-line
|
||||||
StructStore, ID, Doc, AbstractType, // eslint-disable-line
|
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
import * as encoding from 'lib0/encoding'
|
import * as encoding from 'lib0/encoding'
|
||||||
@ -66,7 +66,7 @@ export class RelativePosition {
|
|||||||
* after the meant position.
|
* after the meant position.
|
||||||
* I.e. position 1 in 'ab' is associated to character 'b'.
|
* I.e. position 1 in 'ab' is associated to character 'b'.
|
||||||
*
|
*
|
||||||
* If assoc < 0, then the relative position is associated to the character
|
* If assoc < 0, then the relative position is associated to the caharacter
|
||||||
* before the meant position.
|
* before the meant position.
|
||||||
*
|
*
|
||||||
* @type {number}
|
* @type {number}
|
||||||
@ -102,7 +102,7 @@ export const relativePositionToJSON = rpos => {
|
|||||||
*
|
*
|
||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const createRelativePositionFromJSON = json => new RelativePosition(json.type == null ? null : createID(json.type.client, json.type.clock), json.tname ?? null, json.item == null ? null : createID(json.item.client, json.item.clock), json.assoc == null ? 0 : json.assoc)
|
export const createRelativePositionFromJSON = json => new RelativePosition(json.type == null ? null : createID(json.type.client, json.type.clock), json.tname || null, json.item == null ? null : createID(json.item.client, json.item.clock), json.assoc == null ? 0 : json.assoc)
|
||||||
|
|
||||||
export class AbsolutePosition {
|
export class AbsolutePosition {
|
||||||
/**
|
/**
|
||||||
@ -257,36 +257,13 @@ export const readRelativePosition = decoder => {
|
|||||||
export const decodeRelativePosition = uint8Array => readRelativePosition(decoding.createDecoder(uint8Array))
|
export const decodeRelativePosition = uint8Array => readRelativePosition(decoding.createDecoder(uint8Array))
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {StructStore} store
|
|
||||||
* @param {ID} id
|
|
||||||
*/
|
|
||||||
const getItemWithOffset = (store, id) => {
|
|
||||||
const item = getItem(store, id)
|
|
||||||
const diff = id.clock - item.id.clock
|
|
||||||
return {
|
|
||||||
item, diff
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transform a relative position to an absolute position.
|
|
||||||
*
|
|
||||||
* If you want to share the relative position with other users, you should set
|
|
||||||
* `followUndoneDeletions` to false to get consistent results across all clients.
|
|
||||||
*
|
|
||||||
* When calculating the absolute position, we try to follow the "undone deletions". This yields
|
|
||||||
* better results for the user who performed undo. However, only the user who performed the undo
|
|
||||||
* will get the better results, the other users don't know which operations recreated a deleted
|
|
||||||
* range of content. There is more information in this ticket: https://github.com/yjs/yjs/issues/638
|
|
||||||
*
|
|
||||||
* @param {RelativePosition} rpos
|
* @param {RelativePosition} rpos
|
||||||
* @param {Doc} doc
|
* @param {Doc} doc
|
||||||
* @param {boolean} followUndoneDeletions - whether to follow undone deletions - see https://github.com/yjs/yjs/issues/638
|
|
||||||
* @return {AbsolutePosition|null}
|
* @return {AbsolutePosition|null}
|
||||||
*
|
*
|
||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndoneDeletions = true) => {
|
export const createAbsolutePositionFromRelativePosition = (rpos, doc) => {
|
||||||
const store = doc.store
|
const store = doc.store
|
||||||
const rightID = rpos.item
|
const rightID = rpos.item
|
||||||
const typeID = rpos.type
|
const typeID = rpos.type
|
||||||
@ -298,7 +275,7 @@ export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndo
|
|||||||
if (getState(store, rightID.client) <= rightID.clock) {
|
if (getState(store, rightID.client) <= rightID.clock) {
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
const res = followUndoneDeletions ? followRedone(store, rightID) : getItemWithOffset(store, rightID)
|
const res = followRedone(store, rightID)
|
||||||
const right = res.item
|
const right = res.item
|
||||||
if (!(right instanceof Item)) {
|
if (!(right instanceof Item)) {
|
||||||
return null
|
return null
|
||||||
@ -322,7 +299,7 @@ export const createAbsolutePositionFromRelativePosition = (rpos, doc, followUndo
|
|||||||
// type does not exist yet
|
// type does not exist yet
|
||||||
return null
|
return null
|
||||||
}
|
}
|
||||||
const { item } = followUndoneDeletions ? followRedone(store, typeID) : { item: getItem(store, typeID) }
|
const { item } = followRedone(store, typeID)
|
||||||
if (item instanceof Item && item.content instanceof ContentType) {
|
if (item instanceof Item && item.content instanceof ContentType) {
|
||||||
type = item.content.type
|
type = item.content.type
|
||||||
} else {
|
} else {
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
isDeleted,
|
isDeleted,
|
||||||
createDeleteSetFromStructStore,
|
createDeleteSetFromStructStore,
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
GC,
|
GC,
|
||||||
splitItem,
|
splitItem,
|
||||||
@ -66,13 +67,13 @@ export const getState = (store, client) => {
|
|||||||
* @private
|
* @private
|
||||||
* @function
|
* @function
|
||||||
*/
|
*/
|
||||||
export const integrityCheck = store => {
|
export const integretyCheck = store => {
|
||||||
store.clients.forEach(structs => {
|
store.clients.forEach(structs => {
|
||||||
for (let i = 1; i < structs.length; i++) {
|
for (let i = 1; i < structs.length; i++) {
|
||||||
const l = structs[i - 1]
|
const l = structs[i - 1]
|
||||||
const r = structs[i]
|
const r = structs[i]
|
||||||
if (l.id.clock + l.length !== r.id.clock) {
|
if (l.id.clock + l.length !== r.id.clock) {
|
||||||
throw new Error('StructStore failed integrity check')
|
throw new Error('StructStore failed integrety check')
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
getState,
|
getState,
|
||||||
writeStructsFromTransaction,
|
writeStructsFromTransaction,
|
||||||
@ -28,8 +29,7 @@ import { callAll } from 'lib0/function'
|
|||||||
* possible. Here is an example to illustrate the advantages of bundling:
|
* possible. Here is an example to illustrate the advantages of bundling:
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* const ydoc = new Y.Doc()
|
* const map = y.define('map', YMap)
|
||||||
* const map = ydoc.getMap('map')
|
|
||||||
* // Log content when change is triggered
|
* // Log content when change is triggered
|
||||||
* map.observe(() => {
|
* map.observe(() => {
|
||||||
* console.log('change triggered')
|
* console.log('change triggered')
|
||||||
@ -38,7 +38,7 @@ import { callAll } from 'lib0/function'
|
|||||||
* map.set('a', 0) // => "change triggered"
|
* map.set('a', 0) // => "change triggered"
|
||||||
* map.set('b', 0) // => "change triggered"
|
* map.set('b', 0) // => "change triggered"
|
||||||
* // When put in a transaction, it will trigger the log after the transaction:
|
* // When put in a transaction, it will trigger the log after the transaction:
|
||||||
* ydoc.transact(() => {
|
* y.transact(() => {
|
||||||
* map.set('a', 1)
|
* map.set('a', 1)
|
||||||
* map.set('b', 1)
|
* map.set('b', 1)
|
||||||
* }) // => "change triggered"
|
* }) // => "change triggered"
|
||||||
@ -225,7 +225,7 @@ const tryGcDeleteSet = (ds, store, gcFilter) => {
|
|||||||
*/
|
*/
|
||||||
const tryMergeDeleteSet = (ds, store) => {
|
const tryMergeDeleteSet = (ds, store) => {
|
||||||
// try to merge deleted / gc'd items
|
// try to merge deleted / gc'd items
|
||||||
// merge from right to left for better efficiency and so we don't miss any merge targets
|
// merge from right to left for better efficiecy and so we don't miss any merge targets
|
||||||
ds.clients.forEach((deleteItems, client) => {
|
ds.clients.forEach((deleteItems, client) => {
|
||||||
const structs = /** @type {Array<GC|Item>} */ (store.clients.get(client))
|
const structs = /** @type {Array<GC|Item>} */ (store.clients.get(client))
|
||||||
for (let di = deleteItems.length - 1; di >= 0; di--) {
|
for (let di = deleteItems.length - 1; di >= 0; di--) {
|
||||||
|
@ -10,13 +10,13 @@ import {
|
|||||||
getItemCleanStart,
|
getItemCleanStart,
|
||||||
isDeleted,
|
isDeleted,
|
||||||
addToDeleteSet,
|
addToDeleteSet,
|
||||||
YEvent, Transaction, Doc, Item, GC, DeleteSet, AbstractType // eslint-disable-line
|
Transaction, Doc, Item, GC, DeleteSet, AbstractType // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
|
||||||
import * as time from 'lib0/time'
|
import * as time from 'lib0/time'
|
||||||
import * as array from 'lib0/array'
|
import * as array from 'lib0/array'
|
||||||
import * as logging from 'lib0/logging'
|
import * as logging from 'lib0/logging'
|
||||||
import { ObservableV2 } from 'lib0/observable'
|
import { Observable } from 'lib0/observable'
|
||||||
|
|
||||||
export class StackItem {
|
export class StackItem {
|
||||||
/**
|
/**
|
||||||
@ -39,7 +39,7 @@ export class StackItem {
|
|||||||
*/
|
*/
|
||||||
const clearUndoManagerStackItem = (tr, um, stackItem) => {
|
const clearUndoManagerStackItem = (tr, um, stackItem) => {
|
||||||
iterateDeletedStructs(tr, stackItem.deletions, item => {
|
iterateDeletedStructs(tr, stackItem.deletions, item => {
|
||||||
if (item instanceof Item && um.scope.some(type => type === tr.doc || isParentOf(/** @type {AbstractType<any>} */ (type), item))) {
|
if (item instanceof Item && um.scope.some(type => isParentOf(type, item))) {
|
||||||
keepItem(item, false)
|
keepItem(item, false)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@ -48,10 +48,15 @@ const clearUndoManagerStackItem = (tr, um, stackItem) => {
|
|||||||
/**
|
/**
|
||||||
* @param {UndoManager} undoManager
|
* @param {UndoManager} undoManager
|
||||||
* @param {Array<StackItem>} stack
|
* @param {Array<StackItem>} stack
|
||||||
* @param {'undo'|'redo'} eventType
|
* @param {string} eventType
|
||||||
* @return {StackItem?}
|
* @return {StackItem?}
|
||||||
*/
|
*/
|
||||||
const popStackItem = (undoManager, stack, eventType) => {
|
const popStackItem = (undoManager, stack, eventType) => {
|
||||||
|
/**
|
||||||
|
* Whether a change happened
|
||||||
|
* @type {StackItem?}
|
||||||
|
*/
|
||||||
|
let result = null
|
||||||
/**
|
/**
|
||||||
* Keep a reference to the transaction so we can fire the event with the changedParentTypes
|
* Keep a reference to the transaction so we can fire the event with the changedParentTypes
|
||||||
* @type {any}
|
* @type {any}
|
||||||
@ -60,7 +65,7 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
const doc = undoManager.doc
|
const doc = undoManager.doc
|
||||||
const scope = undoManager.scope
|
const scope = undoManager.scope
|
||||||
transact(doc, transaction => {
|
transact(doc, transaction => {
|
||||||
while (stack.length > 0 && undoManager.currStackItem === null) {
|
while (stack.length > 0 && result === null) {
|
||||||
const store = doc.store
|
const store = doc.store
|
||||||
const stackItem = /** @type {StackItem} */ (stack.pop())
|
const stackItem = /** @type {StackItem} */ (stack.pop())
|
||||||
/**
|
/**
|
||||||
@ -81,7 +86,7 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
}
|
}
|
||||||
struct = item
|
struct = item
|
||||||
}
|
}
|
||||||
if (!struct.deleted && scope.some(type => type === transaction.doc || isParentOf(/** @type {AbstractType<any>} */ (type), /** @type {Item} */ (struct)))) {
|
if (!struct.deleted && scope.some(type => isParentOf(type, /** @type {Item} */ (struct)))) {
|
||||||
itemsToDelete.push(struct)
|
itemsToDelete.push(struct)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -89,7 +94,7 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
iterateDeletedStructs(transaction, stackItem.deletions, struct => {
|
iterateDeletedStructs(transaction, stackItem.deletions, struct => {
|
||||||
if (
|
if (
|
||||||
struct instanceof Item &&
|
struct instanceof Item &&
|
||||||
scope.some(type => type === transaction.doc || isParentOf(/** @type {AbstractType<any>} */ (type), struct)) &&
|
scope.some(type => isParentOf(type, struct)) &&
|
||||||
// Never redo structs in stackItem.insertions because they were created and deleted in the same capture interval.
|
// Never redo structs in stackItem.insertions because they were created and deleted in the same capture interval.
|
||||||
!isDeleted(stackItem.insertions, struct.id)
|
!isDeleted(stackItem.insertions, struct.id)
|
||||||
) {
|
) {
|
||||||
@ -108,7 +113,7 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
performedChange = true
|
performedChange = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
undoManager.currStackItem = performedChange ? stackItem : null
|
result = performedChange ? stackItem : null
|
||||||
}
|
}
|
||||||
transaction.changed.forEach((subProps, type) => {
|
transaction.changed.forEach((subProps, type) => {
|
||||||
// destroy search marker if necessary
|
// destroy search marker if necessary
|
||||||
@ -118,13 +123,11 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
})
|
})
|
||||||
_tr = transaction
|
_tr = transaction
|
||||||
}, undoManager)
|
}, undoManager)
|
||||||
const res = undoManager.currStackItem
|
if (result != null) {
|
||||||
if (res != null) {
|
|
||||||
const changedParentTypes = _tr.changedParentTypes
|
const changedParentTypes = _tr.changedParentTypes
|
||||||
undoManager.emit('stack-item-popped', [{ stackItem: res, type: eventType, changedParentTypes, origin: undoManager }, undoManager])
|
undoManager.emit('stack-item-popped', [{ stackItem: result, type: eventType, changedParentTypes }, undoManager])
|
||||||
undoManager.currStackItem = null
|
|
||||||
}
|
}
|
||||||
return res
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -140,14 +143,6 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
* @property {Doc} [doc] The document that this UndoManager operates on. Only needed if typeScope is empty.
|
* @property {Doc} [doc] The document that this UndoManager operates on. Only needed if typeScope is empty.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
|
||||||
* @typedef {Object} StackItemEvent
|
|
||||||
* @property {StackItem} StackItemEvent.stackItem
|
|
||||||
* @property {any} StackItemEvent.origin
|
|
||||||
* @property {'undo'|'redo'} StackItemEvent.type
|
|
||||||
* @property {Map<AbstractType<YEvent<any>>,Array<YEvent<any>>>} StackItemEvent.changedParentTypes
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fires 'stack-item-added' event when a stack item was added to either the undo- or
|
* Fires 'stack-item-added' event when a stack item was added to either the undo- or
|
||||||
* the redo-stack. You may store additional stack information via the
|
* the redo-stack. You may store additional stack information via the
|
||||||
@ -155,11 +150,11 @@ const popStackItem = (undoManager, stack, eventType) => {
|
|||||||
* Fires 'stack-item-popped' event when a stack item was popped from either the
|
* Fires 'stack-item-popped' event when a stack item was popped from either the
|
||||||
* undo- or the redo-stack. You may restore the saved stack information from `event.stackItem.meta`.
|
* undo- or the redo-stack. You may restore the saved stack information from `event.stackItem.meta`.
|
||||||
*
|
*
|
||||||
* @extends {ObservableV2<{'stack-item-added':function(StackItemEvent, UndoManager):void, 'stack-item-popped': function(StackItemEvent, UndoManager):void, 'stack-cleared': function({ undoStackCleared: boolean, redoStackCleared: boolean }):void, 'stack-item-updated': function(StackItemEvent, UndoManager):void }>}
|
* @extends {Observable<'stack-item-added'|'stack-item-popped'|'stack-cleared'|'stack-item-updated'>}
|
||||||
*/
|
*/
|
||||||
export class UndoManager extends ObservableV2 {
|
export class UndoManager extends Observable {
|
||||||
/**
|
/**
|
||||||
* @param {Doc|AbstractType<any>|Array<AbstractType<any>>} typeScope Limits the scope of the UndoManager. If this is set to a ydoc instance, all changes on that ydoc will be undone. If set to a specific type, only changes on that type or its children will be undone. Also accepts an array of types.
|
* @param {AbstractType<any>|Array<AbstractType<any>>} typeScope Accepts either a single type, or an array of types
|
||||||
* @param {UndoManagerOptions} options
|
* @param {UndoManagerOptions} options
|
||||||
*/
|
*/
|
||||||
constructor (typeScope, {
|
constructor (typeScope, {
|
||||||
@ -168,11 +163,11 @@ export class UndoManager extends ObservableV2 {
|
|||||||
deleteFilter = () => true,
|
deleteFilter = () => true,
|
||||||
trackedOrigins = new Set([null]),
|
trackedOrigins = new Set([null]),
|
||||||
ignoreRemoteMapChanges = false,
|
ignoreRemoteMapChanges = false,
|
||||||
doc = /** @type {Doc} */ (array.isArray(typeScope) ? typeScope[0].doc : typeScope instanceof Doc ? typeScope : typeScope.doc)
|
doc = /** @type {Doc} */ (array.isArray(typeScope) ? typeScope[0].doc : typeScope.doc)
|
||||||
} = {}) {
|
} = {}) {
|
||||||
super()
|
super()
|
||||||
/**
|
/**
|
||||||
* @type {Array<AbstractType<any> | Doc>}
|
* @type {Array<AbstractType<any>>}
|
||||||
*/
|
*/
|
||||||
this.scope = []
|
this.scope = []
|
||||||
this.doc = doc
|
this.doc = doc
|
||||||
@ -196,12 +191,6 @@ export class UndoManager extends ObservableV2 {
|
|||||||
*/
|
*/
|
||||||
this.undoing = false
|
this.undoing = false
|
||||||
this.redoing = false
|
this.redoing = false
|
||||||
/**
|
|
||||||
* The currently popped stack item if UndoManager.undoing or UndoManager.redoing
|
|
||||||
*
|
|
||||||
* @type {StackItem|null}
|
|
||||||
*/
|
|
||||||
this.currStackItem = null
|
|
||||||
this.lastChange = 0
|
this.lastChange = 0
|
||||||
this.ignoreRemoteMapChanges = ignoreRemoteMapChanges
|
this.ignoreRemoteMapChanges = ignoreRemoteMapChanges
|
||||||
this.captureTimeout = captureTimeout
|
this.captureTimeout = captureTimeout
|
||||||
@ -212,7 +201,7 @@ export class UndoManager extends ObservableV2 {
|
|||||||
// Only track certain transactions
|
// Only track certain transactions
|
||||||
if (
|
if (
|
||||||
!this.captureTransaction(transaction) ||
|
!this.captureTransaction(transaction) ||
|
||||||
!this.scope.some(type => transaction.changedParentTypes.has(/** @type {AbstractType<any>} */ (type)) || type === this.doc) ||
|
!this.scope.some(type => transaction.changedParentTypes.has(type)) ||
|
||||||
(!this.trackedOrigins.has(transaction.origin) && (!transaction.origin || !this.trackedOrigins.has(transaction.origin.constructor)))
|
(!this.trackedOrigins.has(transaction.origin) && (!transaction.origin || !this.trackedOrigins.has(transaction.origin.constructor)))
|
||||||
) {
|
) {
|
||||||
return
|
return
|
||||||
@ -251,13 +240,10 @@ export class UndoManager extends ObservableV2 {
|
|||||||
}
|
}
|
||||||
// make sure that deleted structs are not gc'd
|
// make sure that deleted structs are not gc'd
|
||||||
iterateDeletedStructs(transaction, transaction.deleteSet, /** @param {Item|GC} item */ item => {
|
iterateDeletedStructs(transaction, transaction.deleteSet, /** @param {Item|GC} item */ item => {
|
||||||
if (item instanceof Item && this.scope.some(type => type === transaction.doc || isParentOf(/** @type {AbstractType<any>} */ (type), item))) {
|
if (item instanceof Item && this.scope.some(type => isParentOf(type, item))) {
|
||||||
keepItem(item, true)
|
keepItem(item, true)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
/**
|
|
||||||
* @type {[StackItemEvent, UndoManager]}
|
|
||||||
*/
|
|
||||||
const changeEvent = [{ stackItem: stack[stack.length - 1], origin: transaction.origin, type: undoing ? 'redo' : 'undo', changedParentTypes: transaction.changedParentTypes }, this]
|
const changeEvent = [{ stackItem: stack[stack.length - 1], origin: transaction.origin, type: undoing ? 'redo' : 'undo', changedParentTypes: transaction.changedParentTypes }, this]
|
||||||
if (didAdd) {
|
if (didAdd) {
|
||||||
this.emit('stack-item-added', changeEvent)
|
this.emit('stack-item-added', changeEvent)
|
||||||
@ -272,17 +258,13 @@ export class UndoManager extends ObservableV2 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Extend the scope.
|
* @param {Array<AbstractType<any>> | AbstractType<any>} ytypes
|
||||||
*
|
|
||||||
* @param {Array<AbstractType<any> | Doc> | AbstractType<any> | Doc} ytypes
|
|
||||||
*/
|
*/
|
||||||
addToScope (ytypes) {
|
addToScope (ytypes) {
|
||||||
const tmpSet = new Set(this.scope)
|
|
||||||
ytypes = array.isArray(ytypes) ? ytypes : [ytypes]
|
ytypes = array.isArray(ytypes) ? ytypes : [ytypes]
|
||||||
ytypes.forEach(ytype => {
|
ytypes.forEach(ytype => {
|
||||||
if (!tmpSet.has(ytype)) {
|
if (this.scope.every(yt => yt !== ytype)) {
|
||||||
tmpSet.add(ytype)
|
if (ytype.doc !== this.doc) logging.warn('[yjs#509] Not same Y.Doc') // use MultiDocUndoManager instead. also see https://github.com/yjs/yjs/issues/509
|
||||||
if (ytype instanceof AbstractType ? ytype.doc !== this.doc : ytype !== this.doc) logging.warn('[yjs#509] Not same Y.Doc') // use MultiDocUndoManager instead. also see https://github.com/yjs/yjs/issues/509
|
|
||||||
this.scope.push(ytype)
|
this.scope.push(ytype)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import * as error from 'lib0/error'
|
import * as error from 'lib0/error'
|
||||||
import * as encoding from 'lib0/encoding'
|
import * as encoding from 'lib0/encoding'
|
||||||
|
|
||||||
@ -167,7 +168,7 @@ export class UpdateEncoderV2 extends DSEncoderV2 {
|
|||||||
*/
|
*/
|
||||||
this.keyMap = new Map()
|
this.keyMap = new Map()
|
||||||
/**
|
/**
|
||||||
* Refers to the next unique key-identifier to me used.
|
* Refers to the next uniqe key-identifier to me used.
|
||||||
* See writeKey method for more information.
|
* See writeKey method for more information.
|
||||||
*
|
*
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
isDeleted,
|
isDeleted,
|
||||||
Item, AbstractType, Transaction, AbstractStruct // eslint-disable-line
|
Item, AbstractType, Transaction, AbstractStruct // eslint-disable-line
|
||||||
@ -264,8 +265,8 @@ const getPathTo = (parent, child) => {
|
|||||||
let i = 0
|
let i = 0
|
||||||
let c = /** @type {AbstractType<any>} */ (child._item.parent)._start
|
let c = /** @type {AbstractType<any>} */ (child._item.parent)._start
|
||||||
while (c !== child._item && c !== null) {
|
while (c !== child._item && c !== null) {
|
||||||
if (!c.deleted && c.countable) {
|
if (!c.deleted) {
|
||||||
i += c.length
|
i++
|
||||||
}
|
}
|
||||||
c = c.right
|
c = c.right
|
||||||
}
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @module encoding
|
* @module encoding
|
||||||
*/
|
*/
|
||||||
@ -154,7 +155,7 @@ export const readClientsStructRefs = (decoder, doc) => {
|
|||||||
// @type {string|null}
|
// @type {string|null}
|
||||||
const struct = new Item(
|
const struct = new Item(
|
||||||
createID(client, clock),
|
createID(client, clock),
|
||||||
null, // left
|
null, // leftd
|
||||||
(info & binary.BIT8) === binary.BIT8 ? decoder.readLeftID() : null, // origin
|
(info & binary.BIT8) === binary.BIT8 ? decoder.readLeftID() : null, // origin
|
||||||
null, // right
|
null, // right
|
||||||
(info & binary.BIT7) === binary.BIT7 ? decoder.readRightID() : null, // right origin
|
(info & binary.BIT7) === binary.BIT7 ? decoder.readRightID() : null, // right origin
|
||||||
@ -178,7 +179,7 @@ export const readClientsStructRefs = (decoder, doc) => {
|
|||||||
|
|
||||||
const struct = new Item(
|
const struct = new Item(
|
||||||
createID(client, clock),
|
createID(client, clock),
|
||||||
null, // left
|
null, // leftd
|
||||||
origin, // origin
|
origin, // origin
|
||||||
null, // right
|
null, // right
|
||||||
rightOrigin, // right origin
|
rightOrigin, // right origin
|
||||||
@ -211,7 +212,7 @@ export const readClientsStructRefs = (decoder, doc) => {
|
|||||||
* then we start emptying the stack.
|
* then we start emptying the stack.
|
||||||
*
|
*
|
||||||
* It is not possible to have circles: i.e. struct1 (from client1) depends on struct2 (from client2)
|
* It is not possible to have circles: i.e. struct1 (from client1) depends on struct2 (from client2)
|
||||||
* depends on struct3 (from client1). Therefore the max stack size is equal to `structReaders.length`.
|
* depends on struct3 (from client1). Therefore the max stack size is eqaul to `structReaders.length`.
|
||||||
*
|
*
|
||||||
* This method is implemented in a way so that we can resume computation if this update
|
* This method is implemented in a way so that we can resume computation if this update
|
||||||
* causally depends on another update.
|
* causally depends on another update.
|
||||||
@ -279,14 +280,14 @@ const integrateStructs = (transaction, store, clientsStructRefs) => {
|
|||||||
const addStackToRestSS = () => {
|
const addStackToRestSS = () => {
|
||||||
for (const item of stack) {
|
for (const item of stack) {
|
||||||
const client = item.id.client
|
const client = item.id.client
|
||||||
const inapplicableItems = clientsStructRefs.get(client)
|
const unapplicableItems = clientsStructRefs.get(client)
|
||||||
if (inapplicableItems) {
|
if (unapplicableItems) {
|
||||||
// decrement because we weren't able to apply previous operation
|
// decrement because we weren't able to apply previous operation
|
||||||
inapplicableItems.i--
|
unapplicableItems.i--
|
||||||
restStructs.clients.set(client, inapplicableItems.refs.slice(inapplicableItems.i))
|
restStructs.clients.set(client, unapplicableItems.refs.slice(unapplicableItems.i))
|
||||||
clientsStructRefs.delete(client)
|
clientsStructRefs.delete(client)
|
||||||
inapplicableItems.i = 0
|
unapplicableItems.i = 0
|
||||||
inapplicableItems.refs = []
|
unapplicableItems.refs = []
|
||||||
} else {
|
} else {
|
||||||
// item was the last item on clientsStructRefs and the field was already cleared. Add item to restStructs and continue
|
// item was the last item on clientsStructRefs and the field was already cleared. Add item to restStructs and continue
|
||||||
restStructs.clients.set(client, [item])
|
restStructs.clients.set(client, [item])
|
||||||
@ -370,7 +371,7 @@ export const writeStructsFromTransaction = (encoder, transaction) => writeClient
|
|||||||
/**
|
/**
|
||||||
* Read and apply a document update.
|
* Read and apply a document update.
|
||||||
*
|
*
|
||||||
* This function has the same effect as `applyUpdate` but accepts a decoder.
|
* This function has the same effect as `applyUpdate` but accepts an decoder.
|
||||||
*
|
*
|
||||||
* @param {decoding.Decoder} decoder
|
* @param {decoding.Decoder} decoder
|
||||||
* @param {Doc} ydoc
|
* @param {Doc} ydoc
|
||||||
@ -451,7 +452,7 @@ export const readUpdateV2 = (decoder, ydoc, transactionOrigin, structDecoder = n
|
|||||||
/**
|
/**
|
||||||
* Read and apply a document update.
|
* Read and apply a document update.
|
||||||
*
|
*
|
||||||
* This function has the same effect as `applyUpdate` but accepts a decoder.
|
* This function has the same effect as `applyUpdate` but accepts an decoder.
|
||||||
*
|
*
|
||||||
* @param {decoding.Decoder} decoder
|
* @param {decoding.Decoder} decoder
|
||||||
* @param {Doc} ydoc
|
* @param {Doc} ydoc
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import { AbstractType, Item } from '../internals.js' // eslint-disable-line
|
import { AbstractType, Item } from '../internals.js' // eslint-disable-line
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import {
|
import {
|
||||||
AbstractType // eslint-disable-line
|
AbstractType // eslint-disable-line
|
||||||
} from '../internals.js'
|
} from '../internals.js'
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import * as binary from 'lib0/binary'
|
import * as binary from 'lib0/binary'
|
||||||
import * as decoding from 'lib0/decoding'
|
import * as decoding from 'lib0/decoding'
|
||||||
import * as encoding from 'lib0/encoding'
|
import * as encoding from 'lib0/encoding'
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Testing if encoding/decoding compatibility and integration compatibility is given.
|
* Testing if encoding/decoding compatibility and integration compatiblity is given.
|
||||||
* We expect that the document always looks the same, even if we upgrade the integration algorithm, or add additional encoding approaches.
|
* We expect that the document always looks the same, even if we upgrade the integration algorithm, or add additional encoding approaches.
|
||||||
*
|
*
|
||||||
* The v1 documents were generated with Yjs v13.2.0 based on the randomisized tests.
|
* The v1 documents were generated with Yjs v13.2.0 based on the randomisized tests.
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import * as Y from '../src/index.js'
|
import * as Y from '../src/index.js'
|
||||||
import * as t from 'lib0/testing'
|
import * as t from 'lib0/testing'
|
||||||
|
|
||||||
|
@ -15,28 +15,15 @@ import * as relativePositions from './relativePositions.tests.js'
|
|||||||
import { runTests } from 'lib0/testing'
|
import { runTests } from 'lib0/testing'
|
||||||
import { isBrowser, isNode } from 'lib0/environment'
|
import { isBrowser, isNode } from 'lib0/environment'
|
||||||
import * as log from 'lib0/logging'
|
import * as log from 'lib0/logging'
|
||||||
import { environment } from 'lib0'
|
|
||||||
|
|
||||||
if (isBrowser) {
|
if (isBrowser) {
|
||||||
log.createVConsole(document.body)
|
log.createVConsole(document.body)
|
||||||
}
|
}
|
||||||
|
runTests({
|
||||||
/**
|
|
||||||
* @type {any}
|
|
||||||
*/
|
|
||||||
const tests = {
|
|
||||||
doc, map, array, text, xml, encoding, undoredo, compatibility, snapshot, updates, relativePositions
|
doc, map, array, text, xml, encoding, undoredo, compatibility, snapshot, updates, relativePositions
|
||||||
}
|
}).then(success => {
|
||||||
|
|
||||||
const run = async () => {
|
|
||||||
if (environment.isNode) {
|
|
||||||
// tests.nodejs = await import('./node.tests.js')
|
|
||||||
}
|
|
||||||
|
|
||||||
const success = await runTests(tests)
|
|
||||||
/* istanbul ignore next */
|
/* istanbul ignore next */
|
||||||
if (isNode) {
|
if (isNode) {
|
||||||
process.exit(success ? 0 : 1)
|
process.exit(success ? 0 : 1)
|
||||||
}
|
}
|
||||||
}
|
})
|
||||||
run()
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import * as Y from '../src/index.js'
|
import * as Y from '../src/index.js'
|
||||||
import * as t from 'lib0/testing'
|
import * as t from 'lib0/testing'
|
||||||
|
|
||||||
@ -85,26 +86,6 @@ export const testRelativePositionCase6 = tc => {
|
|||||||
checkRelativePositions(ytext)
|
checkRelativePositions(ytext)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Testing https://github.com/yjs/yjs/issues/657
|
|
||||||
*
|
|
||||||
* @param {t.TestCase} tc
|
|
||||||
*/
|
|
||||||
export const testRelativePositionCase7 = tc => {
|
|
||||||
const docA = new Y.Doc()
|
|
||||||
const textA = docA.getText('text')
|
|
||||||
textA.insert(0, 'abcde')
|
|
||||||
// Create a relative position at index 2 in 'textA'
|
|
||||||
const relativePosition = Y.createRelativePositionFromTypeIndex(textA, 2)
|
|
||||||
// Verify that the absolutes positions on 'docA' are the same
|
|
||||||
const absolutePositionWithFollow =
|
|
||||||
Y.createAbsolutePositionFromRelativePosition(relativePosition, docA, true)
|
|
||||||
const absolutePositionWithoutFollow =
|
|
||||||
Y.createAbsolutePositionFromRelativePosition(relativePosition, docA, false)
|
|
||||||
t.assert(absolutePositionWithFollow?.index === 2)
|
|
||||||
t.assert(absolutePositionWithoutFollow?.index === 2)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
@ -121,25 +102,3 @@ export const testRelativePositionAssociationDifference = tc => {
|
|||||||
t.assert(posRight != null && posRight.index === 2)
|
t.assert(posRight != null && posRight.index === 2)
|
||||||
t.assert(posLeft != null && posLeft.index === 1)
|
t.assert(posLeft != null && posLeft.index === 1)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} tc
|
|
||||||
*/
|
|
||||||
export const testRelativePositionWithUndo = tc => {
|
|
||||||
const ydoc = new Y.Doc()
|
|
||||||
const ytext = ydoc.getText()
|
|
||||||
ytext.insert(0, 'hello world')
|
|
||||||
const rpos = Y.createRelativePositionFromTypeIndex(ytext, 1)
|
|
||||||
const um = new Y.UndoManager(ytext)
|
|
||||||
ytext.delete(0, 6)
|
|
||||||
t.assert(Y.createAbsolutePositionFromRelativePosition(rpos, ydoc)?.index === 0)
|
|
||||||
um.undo()
|
|
||||||
t.assert(Y.createAbsolutePositionFromRelativePosition(rpos, ydoc)?.index === 1)
|
|
||||||
const posWithoutFollow = Y.createAbsolutePositionFromRelativePosition(rpos, ydoc, false)
|
|
||||||
console.log({ posWithoutFollow })
|
|
||||||
t.assert(Y.createAbsolutePositionFromRelativePosition(rpos, ydoc, false)?.index === 6)
|
|
||||||
const ydocClone = new Y.Doc()
|
|
||||||
Y.applyUpdate(ydocClone, Y.encodeStateAsUpdate(ydoc))
|
|
||||||
t.assert(Y.createAbsolutePositionFromRelativePosition(rpos, ydocClone)?.index === 6)
|
|
||||||
t.assert(Y.createAbsolutePositionFromRelativePosition(rpos, ydocClone, false)?.index === 6)
|
|
||||||
}
|
|
||||||
|
@ -14,21 +14,6 @@ export const testBasic = _tc => {
|
|||||||
t.assert(restored.getText().toString() === 'world!')
|
t.assert(restored.getText().toString() === 'world!')
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testBasicXmlAttributes = _tc => {
|
|
||||||
const ydoc = new Y.Doc({ gc: false })
|
|
||||||
const yxml = ydoc.getMap().set('el', new Y.XmlElement('div'))
|
|
||||||
const snapshot1 = Y.snapshot(ydoc)
|
|
||||||
yxml.setAttribute('a', '1')
|
|
||||||
const snapshot2 = Y.snapshot(ydoc)
|
|
||||||
yxml.setAttribute('a', '2')
|
|
||||||
t.compare(yxml.getAttributes(), { a: '2' })
|
|
||||||
t.compare(yxml.getAttributes(snapshot2), { a: '1' })
|
|
||||||
t.compare(yxml.getAttributes(snapshot1), {})
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} _tc
|
* @param {t.TestCase} _tc
|
||||||
*/
|
*/
|
||||||
@ -58,7 +43,7 @@ export const testEmptyRestoreSnapshot = _tc => {
|
|||||||
t.compare(docRestored.getArray().toArray(), [])
|
t.compare(docRestored.getArray().toArray(), [])
|
||||||
t.compare(doc.getArray().toArray(), ['world'])
|
t.compare(doc.getArray().toArray(), ['world'])
|
||||||
|
|
||||||
// now this snapshot reflects the latest state. It should still work.
|
// now this snapshot reflects the latest state. It shoult still work.
|
||||||
const snap2 = Y.snapshot(doc)
|
const snap2 = Y.snapshot(doc)
|
||||||
const docRestored2 = Y.createDocFromSnapshot(doc, snap2)
|
const docRestored2 = Y.createDocFromSnapshot(doc, snap2)
|
||||||
t.compare(docRestored2.getArray().toArray(), ['world'])
|
t.compare(docRestored2.getArray().toArray(), ['world'])
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
|
||||||
import * as t from 'lib0/testing'
|
import * as t from 'lib0/testing'
|
||||||
import * as prng from 'lib0/prng'
|
import * as prng from 'lib0/prng'
|
||||||
import * as encoding from 'lib0/encoding'
|
import * as encoding from 'lib0/encoding'
|
||||||
@ -34,7 +35,7 @@ export const encV1 = {
|
|||||||
mergeUpdates: Y.mergeUpdates,
|
mergeUpdates: Y.mergeUpdates,
|
||||||
applyUpdate: Y.applyUpdate,
|
applyUpdate: Y.applyUpdate,
|
||||||
logUpdate: Y.logUpdate,
|
logUpdate: Y.logUpdate,
|
||||||
updateEventName: /** @type {'update'} */ ('update'),
|
updateEventName: 'update',
|
||||||
diffUpdate: Y.diffUpdate
|
diffUpdate: Y.diffUpdate
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -43,7 +44,7 @@ export const encV2 = {
|
|||||||
mergeUpdates: Y.mergeUpdatesV2,
|
mergeUpdates: Y.mergeUpdatesV2,
|
||||||
applyUpdate: Y.applyUpdateV2,
|
applyUpdate: Y.applyUpdateV2,
|
||||||
logUpdate: Y.logUpdateV2,
|
logUpdate: Y.logUpdateV2,
|
||||||
updateEventName: /** @type {'updateV2'} */ ('updateV2'),
|
updateEventName: 'updateV2',
|
||||||
diffUpdate: Y.diffUpdateV2
|
diffUpdate: Y.diffUpdateV2
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -3,46 +3,6 @@ import { init } from './testHelper.js' // eslint-disable-line
|
|||||||
import * as Y from '../src/index.js'
|
import * as Y from '../src/index.js'
|
||||||
import * as t from 'lib0/testing'
|
import * as t from 'lib0/testing'
|
||||||
|
|
||||||
export const testInconsistentFormat = () => {
|
|
||||||
/**
|
|
||||||
* @param {Y.Doc} ydoc
|
|
||||||
*/
|
|
||||||
const testYjsMerge = ydoc => {
|
|
||||||
const content = /** @type {Y.XmlText} */ (ydoc.get('text', Y.XmlText))
|
|
||||||
content.format(0, 6, { bold: null })
|
|
||||||
content.format(6, 4, { type: 'text' })
|
|
||||||
t.compare(content.toDelta(), [
|
|
||||||
{
|
|
||||||
attributes: { type: 'text' },
|
|
||||||
insert: 'Merge Test'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
attributes: { type: 'text', italic: true },
|
|
||||||
insert: ' After'
|
|
||||||
}
|
|
||||||
])
|
|
||||||
}
|
|
||||||
const initializeYDoc = () => {
|
|
||||||
const yDoc = new Y.Doc({ gc: false })
|
|
||||||
|
|
||||||
const content = /** @type {Y.XmlText} */ (yDoc.get('text', Y.XmlText))
|
|
||||||
content.insert(0, ' After', { type: 'text', italic: true })
|
|
||||||
content.insert(0, 'Test', { type: 'text' })
|
|
||||||
content.insert(0, 'Merge ', { type: 'text', bold: true })
|
|
||||||
return yDoc
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const yDoc = initializeYDoc()
|
|
||||||
testYjsMerge(yDoc)
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const initialYDoc = initializeYDoc()
|
|
||||||
const yDoc = new Y.Doc({ gc: false })
|
|
||||||
Y.applyUpdate(yDoc, Y.encodeStateAsUpdate(initialYDoc))
|
|
||||||
testYjsMerge(yDoc)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
@ -116,72 +76,6 @@ export const testEmptyTypeScope = _tc => {
|
|||||||
t.assert(yarray.length === 0)
|
t.assert(yarray.length === 0)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testRejectUpdateExample = _tc => {
|
|
||||||
const tmpydoc1 = new Y.Doc()
|
|
||||||
tmpydoc1.getArray('restricted').insert(0, [1])
|
|
||||||
tmpydoc1.getArray('public').insert(0, [1])
|
|
||||||
const update1 = Y.encodeStateAsUpdate(tmpydoc1)
|
|
||||||
const tmpydoc2 = new Y.Doc()
|
|
||||||
tmpydoc2.getArray('public').insert(0, [2])
|
|
||||||
const update2 = Y.encodeStateAsUpdate(tmpydoc2)
|
|
||||||
|
|
||||||
const ydoc = new Y.Doc()
|
|
||||||
const restrictedType = ydoc.getArray('restricted')
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Assume this function handles incoming updates via a communication channel like websockets.
|
|
||||||
* Changes to the `ydoc.getMap('restricted')` type should be rejected.
|
|
||||||
*
|
|
||||||
* - set up undo manager on the restricted types
|
|
||||||
* - cache pending* updates from the Ydoc to avoid certain attacks
|
|
||||||
* - apply received update and check whether the restricted type (or any of its children) has been changed.
|
|
||||||
* - catch errors that might try to circumvent the restrictions
|
|
||||||
* - undo changes on restricted types
|
|
||||||
* - reapply pending* updates
|
|
||||||
*
|
|
||||||
* @param {Uint8Array} update
|
|
||||||
*/
|
|
||||||
const updateHandler = (update) => {
|
|
||||||
// don't handle changes of the local undo manager, which is used to undo invalid changes
|
|
||||||
const um = new Y.UndoManager(restrictedType, { trackedOrigins: new Set(['remote change']) })
|
|
||||||
const beforePendingDs = ydoc.store.pendingDs
|
|
||||||
const beforePendingStructs = ydoc.store.pendingStructs?.update
|
|
||||||
try {
|
|
||||||
Y.applyUpdate(ydoc, update, 'remote change')
|
|
||||||
} finally {
|
|
||||||
while (um.undoStack.length) {
|
|
||||||
um.undo()
|
|
||||||
}
|
|
||||||
um.destroy()
|
|
||||||
ydoc.store.pendingDs = beforePendingDs
|
|
||||||
ydoc.store.pendingStructs = null
|
|
||||||
if (beforePendingStructs) {
|
|
||||||
Y.applyUpdateV2(ydoc, beforePendingStructs)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
updateHandler(update1)
|
|
||||||
updateHandler(update2)
|
|
||||||
t.assert(restrictedType.length === 0)
|
|
||||||
t.assert(ydoc.getArray('public').length === 2)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Test case to fix #241
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testGlobalScope = _tc => {
|
|
||||||
const ydoc = new Y.Doc()
|
|
||||||
const um = new Y.UndoManager(ydoc)
|
|
||||||
const yarray = ydoc.getArray()
|
|
||||||
yarray.insert(0, [1])
|
|
||||||
um.undo()
|
|
||||||
t.assert(yarray.length === 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Test case to fix #241
|
* Test case to fix #241
|
||||||
* @param {t.TestCase} _tc
|
* @param {t.TestCase} _tc
|
||||||
@ -781,33 +675,3 @@ export const testUndoDeleteInMap = (tc) => {
|
|||||||
undoManager.undo()
|
undoManager.undo()
|
||||||
t.compare(map0.toJSON(), { a: 'a' })
|
t.compare(map0.toJSON(), { a: 'a' })
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* It should expose the StackItem being processed if undoing
|
|
||||||
*
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testUndoDoingStackItem = async (_tc) => {
|
|
||||||
const doc = new Y.Doc()
|
|
||||||
const text = doc.getText('text')
|
|
||||||
const undoManager = new Y.UndoManager([text])
|
|
||||||
undoManager.on('stack-item-added', /** @param {any} event */ event => {
|
|
||||||
event.stackItem.meta.set('str', '42')
|
|
||||||
})
|
|
||||||
let metaUndo = /** @type {any} */ (null)
|
|
||||||
let metaRedo = /** @type {any} */ (null)
|
|
||||||
text.observe((event) => {
|
|
||||||
const /** @type {Y.UndoManager} */ origin = event.transaction.origin
|
|
||||||
if (origin === undoManager && origin.undoing) {
|
|
||||||
metaUndo = origin.currStackItem?.meta.get('str')
|
|
||||||
} else if (origin === undoManager && origin.redoing) {
|
|
||||||
metaRedo = origin.currStackItem?.meta.get('str')
|
|
||||||
}
|
|
||||||
})
|
|
||||||
text.insert(0, 'abc')
|
|
||||||
undoManager.undo()
|
|
||||||
undoManager.redo()
|
|
||||||
t.compare(metaUndo, '42', 'currStackItem is accessible while undoing')
|
|
||||||
t.compare(metaRedo, '42', 'currStackItem is accessible while redoing')
|
|
||||||
t.compare(undoManager.currStackItem, null, 'currStackItem is null after observe/transaction')
|
|
||||||
}
|
|
||||||
|
@ -15,7 +15,7 @@ import * as object from 'lib0/object'
|
|||||||
* @property {function(Uint8Array):{from:Map<number,number>,to:Map<number,number>}} Enc.parseUpdateMeta
|
* @property {function(Uint8Array):{from:Map<number,number>,to:Map<number,number>}} Enc.parseUpdateMeta
|
||||||
* @property {function(Y.Doc):Uint8Array} Enc.encodeStateVector
|
* @property {function(Y.Doc):Uint8Array} Enc.encodeStateVector
|
||||||
* @property {function(Uint8Array):Uint8Array} Enc.encodeStateVectorFromUpdate
|
* @property {function(Uint8Array):Uint8Array} Enc.encodeStateVectorFromUpdate
|
||||||
* @property {'update'|'updateV2'} Enc.updateEventName
|
* @property {string} Enc.updateEventName
|
||||||
* @property {string} Enc.description
|
* @property {string} Enc.description
|
||||||
* @property {function(Uint8Array, Uint8Array):Uint8Array} Enc.diffUpdate
|
* @property {function(Uint8Array, Uint8Array):Uint8Array} Enc.diffUpdate
|
||||||
*/
|
*/
|
||||||
@ -169,7 +169,7 @@ const checkUpdateCases = (ydoc, updates, enc, hasDeletes) => {
|
|||||||
// t.info('Target State: ')
|
// t.info('Target State: ')
|
||||||
// enc.logUpdate(targetState)
|
// enc.logUpdate(targetState)
|
||||||
|
|
||||||
cases.forEach((mergedUpdates) => {
|
cases.forEach((mergedUpdates, i) => {
|
||||||
// t.info('State Case $' + i + ':')
|
// t.info('State Case $' + i + ':')
|
||||||
// enc.logUpdate(updates)
|
// enc.logUpdate(updates)
|
||||||
const merged = new Y.Doc({ gc: false })
|
const merged = new Y.Doc({ gc: false })
|
||||||
@ -218,10 +218,10 @@ const checkUpdateCases = (ydoc, updates, enc, hasDeletes) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} _tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
export const testMergeUpdates1 = _tc => {
|
export const testMergeUpdates1 = tc => {
|
||||||
encoders.forEach((enc) => {
|
encoders.forEach((enc, i) => {
|
||||||
t.info(`Using encoder: ${enc.description}`)
|
t.info(`Using encoder: ${enc.description}`)
|
||||||
const ydoc = new Y.Doc({ gc: false })
|
const ydoc = new Y.Doc({ gc: false })
|
||||||
const updates = /** @type {Array<Uint8Array>} */ ([])
|
const updates = /** @type {Array<Uint8Array>} */ ([])
|
||||||
@ -299,16 +299,16 @@ export const testMergePendingUpdates = tc => {
|
|||||||
Y.applyUpdate(yDoc5, update4)
|
Y.applyUpdate(yDoc5, update4)
|
||||||
Y.applyUpdate(yDoc5, serverUpdates[4])
|
Y.applyUpdate(yDoc5, serverUpdates[4])
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
const _update5 = Y.encodeStateAsUpdate(yDoc5) // eslint-disable-line
|
const update5 = Y.encodeStateAsUpdate(yDoc5) // eslint-disable-line
|
||||||
|
|
||||||
const yText5 = yDoc5.getText('textBlock')
|
const yText5 = yDoc5.getText('textBlock')
|
||||||
t.compareStrings(yText5.toString(), 'nenor')
|
t.compareStrings(yText5.toString(), 'nenor')
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} _tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
export const testObfuscateUpdates = _tc => {
|
export const testObfuscateUpdates = tc => {
|
||||||
const ydoc = new Y.Doc()
|
const ydoc = new Y.Doc()
|
||||||
const ytext = ydoc.getText('text')
|
const ytext = ydoc.getText('text')
|
||||||
const ymap = ydoc.getMap('map')
|
const ymap = ydoc.getMap('map')
|
||||||
|
@ -4,9 +4,6 @@ import * as Y from '../src/index.js'
|
|||||||
import * as t from 'lib0/testing'
|
import * as t from 'lib0/testing'
|
||||||
import * as prng from 'lib0/prng'
|
import * as prng from 'lib0/prng'
|
||||||
import * as math from 'lib0/math'
|
import * as math from 'lib0/math'
|
||||||
import * as env from 'lib0/environment'
|
|
||||||
|
|
||||||
const isDevMode = env.getVariable('node_env') === 'development'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} tc
|
* @param {t.TestCase} tc
|
||||||
@ -20,28 +17,6 @@ export const testBasicUpdate = tc => {
|
|||||||
t.compare(doc2.getArray('array').toArray(), ['hi'])
|
t.compare(doc2.getArray('array').toArray(), ['hi'])
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} tc
|
|
||||||
*/
|
|
||||||
export const testFailsObjectManipulationInDevMode = tc => {
|
|
||||||
if (isDevMode) {
|
|
||||||
t.info('running in dev mode')
|
|
||||||
const doc = new Y.Doc()
|
|
||||||
const a = [1, 2, 3]
|
|
||||||
const b = { o: 1 }
|
|
||||||
doc.getArray('test').insert(0, [a])
|
|
||||||
doc.getMap('map').set('k', b)
|
|
||||||
t.fails(() => {
|
|
||||||
a[0] = 42
|
|
||||||
})
|
|
||||||
t.fails(() => {
|
|
||||||
b.o = 42
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
t.info('not in dev mode')
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
@ -355,29 +330,6 @@ export const testObserveDeepEventOrder = tc => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Correct index when computing event.path in observeDeep - https://github.com/yjs/yjs/issues/457
|
|
||||||
*
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testObservedeepIndexes = _tc => {
|
|
||||||
const doc = new Y.Doc()
|
|
||||||
const map = doc.getMap()
|
|
||||||
// Create a field with the array as value
|
|
||||||
map.set('my-array', new Y.Array())
|
|
||||||
// Fill the array with some strings and our Map
|
|
||||||
map.get('my-array').push(['a', 'b', 'c', new Y.Map()])
|
|
||||||
/**
|
|
||||||
* @type {Array<any>}
|
|
||||||
*/
|
|
||||||
let eventPath = []
|
|
||||||
map.observeDeep((events) => { eventPath = events[0].path })
|
|
||||||
// set a value on the map inside of our array
|
|
||||||
map.get('my-array').get(3).set('hello', 'world')
|
|
||||||
console.log(eventPath)
|
|
||||||
t.compare(eventPath, ['my-array', 3])
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} tc
|
* @param {t.TestCase} tc
|
||||||
*/
|
*/
|
||||||
|
@ -369,11 +369,11 @@ export const testObserversUsingObservedeep = tc => {
|
|||||||
/**
|
/**
|
||||||
* @type {Array<Array<string|number>>}
|
* @type {Array<Array<string|number>>}
|
||||||
*/
|
*/
|
||||||
const paths = []
|
const pathes = []
|
||||||
let calls = 0
|
let calls = 0
|
||||||
map0.observeDeep(events => {
|
map0.observeDeep(events => {
|
||||||
events.forEach(event => {
|
events.forEach(event => {
|
||||||
paths.push(event.path)
|
pathes.push(event.path)
|
||||||
})
|
})
|
||||||
calls++
|
calls++
|
||||||
})
|
})
|
||||||
@ -381,7 +381,7 @@ export const testObserversUsingObservedeep = tc => {
|
|||||||
map0.get('map').set('array', new Y.Array())
|
map0.get('map').set('array', new Y.Array())
|
||||||
map0.get('map').get('array').insert(0, ['content'])
|
map0.get('map').get('array').insert(0, ['content'])
|
||||||
t.assert(calls === 3)
|
t.assert(calls === 3)
|
||||||
t.compare(paths, [[], ['map'], ['map', 'array']])
|
t.compare(pathes, [[], ['map'], ['map', 'array']])
|
||||||
compare(users)
|
compare(users)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -393,14 +393,14 @@ export const testPathsOfSiblingEvents = tc => {
|
|||||||
/**
|
/**
|
||||||
* @type {Array<Array<string|number>>}
|
* @type {Array<Array<string|number>>}
|
||||||
*/
|
*/
|
||||||
const paths = []
|
const pathes = []
|
||||||
let calls = 0
|
let calls = 0
|
||||||
const doc = users[0]
|
const doc = users[0]
|
||||||
map0.set('map', new Y.Map())
|
map0.set('map', new Y.Map())
|
||||||
map0.get('map').set('text1', new Y.Text('initial'))
|
map0.get('map').set('text1', new Y.Text('initial'))
|
||||||
map0.observeDeep(events => {
|
map0.observeDeep(events => {
|
||||||
events.forEach(event => {
|
events.forEach(event => {
|
||||||
paths.push(event.path)
|
pathes.push(event.path)
|
||||||
})
|
})
|
||||||
calls++
|
calls++
|
||||||
})
|
})
|
||||||
@ -409,7 +409,7 @@ export const testPathsOfSiblingEvents = tc => {
|
|||||||
map0.get('map').set('text2', new Y.Text('new'))
|
map0.get('map').set('text2', new Y.Text('new'))
|
||||||
})
|
})
|
||||||
t.assert(calls === 1)
|
t.assert(calls === 1)
|
||||||
t.compare(paths, [['map'], ['map', 'text1']])
|
t.compare(pathes, [['map'], ['map', 'text1']])
|
||||||
compare(users)
|
compare(users)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -376,7 +376,7 @@ export const testDeltaBug = _tc => {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
insert: '\n',
|
insert: '\n',
|
||||||
// This attributes has only list and no table-cell-line
|
// This attibutes has only list and no table-cell-line
|
||||||
attributes: {
|
attributes: {
|
||||||
list: {
|
list: {
|
||||||
rowspan: '1',
|
rowspan: '1',
|
||||||
@ -1746,27 +1746,6 @@ export const testBasicFormat = tc => {
|
|||||||
compare(users)
|
compare(users)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} tc
|
|
||||||
*/
|
|
||||||
export const testFalsyFormats = tc => {
|
|
||||||
const { users, text0 } = init(tc, { users: 2 })
|
|
||||||
let delta
|
|
||||||
text0.observe(event => {
|
|
||||||
delta = event.delta
|
|
||||||
})
|
|
||||||
text0.insert(0, 'abcde', { falsy: false })
|
|
||||||
t.compare(text0.toDelta(), [{ insert: 'abcde', attributes: { falsy: false } }])
|
|
||||||
t.compare(delta, [{ insert: 'abcde', attributes: { falsy: false } }])
|
|
||||||
text0.format(1, 3, { falsy: true })
|
|
||||||
t.compare(text0.toDelta(), [{ insert: 'a', attributes: { falsy: false } }, { insert: 'bcd', attributes: { falsy: true } }, { insert: 'e', attributes: { falsy: false } }])
|
|
||||||
t.compare(delta, [{ retain: 1 }, { retain: 3, attributes: { falsy: true } }])
|
|
||||||
text0.format(2, 1, { falsy: false })
|
|
||||||
t.compare(text0.toDelta(), [{ insert: 'a', attributes: { falsy: false } }, { insert: 'b', attributes: { falsy: true } }, { insert: 'c', attributes: { falsy: false } }, { insert: 'd', attributes: { falsy: true } }, { insert: 'e', attributes: { falsy: false } }])
|
|
||||||
t.compare(delta, [{ retain: 2 }, { retain: 1, attributes: { falsy: false } }])
|
|
||||||
compare(users)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {t.TestCase} _tc
|
* @param {t.TestCase} _tc
|
||||||
*/
|
*/
|
||||||
|
@ -189,6 +189,7 @@ export const testClone = _tc => {
|
|||||||
const third = new Y.XmlElement('p')
|
const third = new Y.XmlElement('p')
|
||||||
yxml.push([first, second, third])
|
yxml.push([first, second, third])
|
||||||
t.compareArrays(yxml.toArray(), [first, second, third])
|
t.compareArrays(yxml.toArray(), [first, second, third])
|
||||||
|
|
||||||
const cloneYxml = yxml.clone()
|
const cloneYxml = yxml.clone()
|
||||||
ydoc.getArray('copyarr').insert(0, [cloneYxml])
|
ydoc.getArray('copyarr').insert(0, [cloneYxml])
|
||||||
t.assert(cloneYxml.length === 3)
|
t.assert(cloneYxml.length === 3)
|
||||||
@ -209,15 +210,3 @@ export const testFormattingBug = _tc => {
|
|||||||
yxml.applyDelta(delta)
|
yxml.applyDelta(delta)
|
||||||
t.compare(yxml.toDelta(), delta)
|
t.compare(yxml.toDelta(), delta)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {t.TestCase} _tc
|
|
||||||
*/
|
|
||||||
export const testElement = _tc => {
|
|
||||||
const ydoc = new Y.Doc()
|
|
||||||
const yxmlel = ydoc.getXmlElement()
|
|
||||||
const text1 = new Y.XmlText('text1')
|
|
||||||
const text2 = new Y.XmlText('text2')
|
|
||||||
yxmlel.insert(0, [text1, text2])
|
|
||||||
t.compareArrays(yxmlel.toArray(), [text1, text2])
|
|
||||||
}
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user