1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
use crate::collection::SharedCollection;
use crate::js::{Js, ValueRef, YRange};
use crate::transaction::YTransaction;
use crate::weak::YWeakLink;
use crate::{ImplicitTransaction, Observer, YSnapshot};
use wasm_bindgen::prelude::wasm_bindgen;
use wasm_bindgen::JsValue;
use yrs::types::text::TextEvent;
use yrs::types::{Attrs, TYPE_REFS_TEXT};
use yrs::{DeepObservable, GetString, Observable, Quotable, Text, TextRef, TransactionMut};
/// A shared data type used for collaborative text editing. It enables multiple users to add and
/// remove chunks of text in efficient manner. This type is internally represented as a mutable
/// double-linked list of text chunks - an optimization occurs during `YTransaction.commit`, which
/// allows to squash multiple consecutively inserted characters together as a single chunk of text
/// even between transaction boundaries in order to preserve more efficient memory model.
///
/// `YText` structure internally uses UTF-8 encoding and its length is described in a number of
/// bytes rather than individual characters (a single UTF-8 code point can consist of many bytes).
///
/// Like all Yrs shared data types, `YText` is resistant to the problem of interleaving (situation
/// when characters inserted one after another may interleave with other peers concurrent inserts
/// after merging all updates together). In case of Yrs conflict resolution is solved by using
/// unique document id to determine correct and consistent ordering.
#[wasm_bindgen]
pub struct YText(pub(crate) SharedCollection<String, TextRef>);
#[wasm_bindgen]
impl YText {
/// Creates a new preliminary instance of a `YText` shared data type, with its state initialized
/// to provided parameter.
///
/// Preliminary instances can be nested into other shared data types such as `YArray` and `YMap`.
/// Once a preliminary instance has been inserted this way, it becomes integrated into ywasm
/// document store and cannot be nested again: attempt to do so will result in an exception.
#[wasm_bindgen(constructor)]
pub fn new(init: Option<String>) -> Self {
YText(SharedCollection::prelim(init.unwrap_or_default()))
}
#[wasm_bindgen(getter, js_name = type)]
#[inline]
pub fn get_type(&self) -> u8 {
TYPE_REFS_TEXT
}
/// Gets unique logical identifier of this type, shared across peers collaborating on the same
/// document.
#[wasm_bindgen(getter, js_name = id)]
#[inline]
pub fn id(&self) -> crate::Result<JsValue> {
self.0.id()
}
/// Returns true if this is a preliminary instance of `YArray`.
///
/// Preliminary instances can be nested into other shared data types such as `YArray` and `YMap`.
/// Once a preliminary instance has been inserted this way, it becomes integrated into ywasm
/// document store and cannot be nested again: attempt to do so will result in an exception.
#[wasm_bindgen(getter)]
#[inline]
pub fn prelim(&self) -> bool {
self.0.is_prelim()
}
/// Checks if current YArray reference is alive and has not been deleted by its parent collection.
/// This method only works on already integrated shared types and will return false is current
/// type is preliminary (has not been integrated into document).
#[wasm_bindgen(js_name = alive)]
#[inline]
pub fn alive(&self, txn: &YTransaction) -> bool {
self.0.is_alive(txn)
}
/// Returns length of an underlying string stored in this `YText` instance,
/// understood as a number of UTF-8 encoded bytes.
#[wasm_bindgen(js_name = length)]
pub fn length(&self, txn: &ImplicitTransaction) -> crate::Result<u32> {
match &self.0 {
SharedCollection::Prelim(c) => Ok(c.len() as u32),
SharedCollection::Integrated(c) => c.readonly(txn, |c, txn| Ok(c.len(txn))),
}
}
/// Returns an underlying shared string stored in this data type.
#[wasm_bindgen(js_name = toString)]
pub fn to_string(&self, txn: &ImplicitTransaction) -> crate::Result<String> {
match &self.0 {
SharedCollection::Prelim(c) => Ok(c.clone()),
SharedCollection::Integrated(c) => c.readonly(txn, |c, txn| Ok(c.get_string(txn))),
}
}
/// Returns an underlying shared string stored in this data type.
#[wasm_bindgen(js_name = toJson)]
pub fn to_json(&self, txn: &ImplicitTransaction) -> crate::Result<JsValue> {
match &self.0 {
SharedCollection::Prelim(c) => Ok(c.clone().into()),
SharedCollection::Integrated(c) => {
c.readonly(txn, |c, txn| Ok(c.get_string(txn).into()))
}
}
}
/// Inserts a given `chunk` of text into this `YText` instance, starting at a given `index`.
///
/// Optional object with defined `attributes` will be used to wrap provided text `chunk`
/// with a formatting blocks.`attributes` are only supported for a `YText` instance which
/// already has been integrated into document store.
#[wasm_bindgen(js_name = insert)]
pub fn insert(
&mut self,
index: u32,
chunk: &str,
attributes: JsValue,
txn: ImplicitTransaction,
) -> crate::Result<()> {
match &mut self.0 {
SharedCollection::Prelim(c) => {
if attributes.is_undefined() || attributes.is_null() {
c.insert_str(index as usize, chunk);
Ok(())
} else {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
if attributes.is_undefined() || attributes.is_null() {
c.insert(txn, index, chunk);
Ok(())
} else if let Some(attrs) = Self::parse_fmt(attributes) {
c.insert_with_attributes(txn, index, chunk, attrs);
Ok(())
} else {
Err(JsValue::from_str(crate::js::errors::INVALID_FMT))
}
}),
}
}
/// Inserts a given `embed` object into this `YText` instance, starting at a given `index`.
///
/// Optional object with defined `attributes` will be used to wrap provided `embed`
/// with a formatting blocks.`attributes` are only supported for a `YText` instance which
/// already has been integrated into document store.
#[wasm_bindgen(js_name = insertEmbed)]
pub fn insert_embed(
&self,
index: u32,
embed: JsValue,
attributes: JsValue,
txn: ImplicitTransaction,
) -> crate::Result<()> {
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
if attributes.is_undefined() || attributes.is_null() {
c.insert_embed(txn, index, Js::new(embed));
Ok(())
} else if let Some(attrs) = Self::parse_fmt(attributes) {
c.insert_embed_with_attributes(txn, index, Js::new(embed), attrs);
Ok(())
} else {
Err(JsValue::from_str(crate::js::errors::INVALID_FMT))
}
}),
}
}
/// Wraps an existing piece of text within a range described by `index`-`length` parameters with
/// formatting blocks containing provided `attributes` metadata. This method only works for
/// `YText` instances that already have been integrated into document store.
#[wasm_bindgen(js_name = format)]
pub fn format(
&self,
index: u32,
length: u32,
attributes: JsValue,
txn: ImplicitTransaction,
) -> crate::Result<()> {
let attrs = match Self::parse_fmt(attributes) {
Some(attrs) => attrs,
None => return Err(JsValue::from_str(crate::js::errors::INVALID_FMT)),
};
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
c.format(txn, index, length, attrs);
Ok(())
}),
}
}
pub(crate) fn parse_fmt(attrs: JsValue) -> Option<Attrs> {
if attrs.is_object() {
let mut map = Attrs::new();
let object = js_sys::Object::from(attrs);
let entries = js_sys::Object::entries(&object);
for tuple in entries.iter() {
let tuple = js_sys::Array::from(&tuple);
let key: String = tuple.get(0).as_string()?;
let value = Js::new(tuple.get(1));
if let Ok(ValueRef::Any(any)) = value.as_value() {
map.insert(key.into(), any);
} else {
return None;
}
}
Some(map)
} else {
None
}
}
/// Appends a given `chunk` of text at the end of current `YText` instance.
///
/// Optional object with defined `attributes` will be used to wrap provided text `chunk`
/// with a formatting blocks.`attributes` are only supported for a `YText` instance which
/// already has been integrated into document store.
#[wasm_bindgen(js_name = push)]
pub fn push(
&mut self,
chunk: &str,
attributes: JsValue,
txn: ImplicitTransaction,
) -> crate::Result<()> {
match &mut self.0 {
SharedCollection::Prelim(c) => {
if attributes.is_undefined() || attributes.is_null() {
c.push_str(chunk);
Ok(())
} else {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
if attributes.is_undefined() || attributes.is_null() {
c.push(txn, chunk);
Ok(())
} else if let Some(attrs) = Self::parse_fmt(attributes) {
let len = c.len(txn);
c.insert_with_attributes(txn, len, chunk, attrs);
Ok(())
} else {
Err(JsValue::from_str(crate::js::errors::INVALID_FMT))
}
}),
}
}
/// Deletes a specified range of of characters, starting at a given `index`.
/// Both `index` and `length` are counted in terms of a number of UTF-8 character bytes.
#[wasm_bindgen(method, js_name = delete)]
pub fn delete(
&mut self,
index: u32,
length: u32,
txn: ImplicitTransaction,
) -> crate::Result<()> {
match &mut self.0 {
SharedCollection::Prelim(c) => {
c.drain((index as usize)..((index + length) as usize));
Ok(())
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
c.remove_range(txn, index, length);
Ok(())
}),
}
}
#[wasm_bindgen(js_name = quote)]
pub fn quote(
&self,
lower: u32,
upper: u32,
lower_open: Option<bool>,
upper_open: Option<bool>,
txn: &ImplicitTransaction,
) -> crate::Result<YWeakLink> {
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => c.readonly(txn, |c, txn| {
let range = YRange::new(lower, upper, lower_open, upper_open);
let quote = c
.quote(txn, range)
.map_err(|e| JsValue::from_str(&e.to_string()))?;
Ok(YWeakLink::from_prelim(quote, txn.doc().clone()))
}),
}
}
/// Returns the Delta representation of this YText type.
#[wasm_bindgen(js_name = toDelta)]
pub fn to_delta(
&self,
snapshot: Option<YSnapshot>,
prev_snapshot: Option<YSnapshot>,
compute_ychange: Option<js_sys::Function>,
txn: ImplicitTransaction,
) -> crate::Result<js_sys::Array> {
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => c.mutably(txn, |c, txn| {
let doc = txn.doc().clone();
let hi = snapshot.map(|s| s.0);
let lo = prev_snapshot.map(|s| s.0);
let array = js_sys::Array::new();
let delta = c.diff_range(txn, hi.as_ref(), lo.as_ref(), |change| {
crate::js::convert::ychange_to_js(change, &compute_ychange).unwrap()
});
for d in delta {
let d = crate::js::convert::diff_into_js(d, &doc)?;
array.push(&d);
}
Ok(array)
}),
}
}
/// Subscribes to all operations happening over this instance of `YText`. All changes are
/// batched and eventually triggered during transaction commit phase.
/// Returns an `YTextObserver` which, when free'd, will unsubscribe current callback.
#[wasm_bindgen(js_name = observe)]
pub fn observe(&self, f: js_sys::Function) -> crate::Result<Observer> {
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => {
let txn = c.transact()?;
let array = c.resolve(&txn)?;
Ok(Observer(array.observe(move |txn, e| {
let e = YTextEvent::new(e, txn);
let txn = YTransaction::from_ref(txn);
f.call2(&JsValue::UNDEFINED, &e.into(), &txn.into())
.unwrap();
})))
}
}
}
/// Subscribes to all operations happening over this Y shared type, as well as events in
/// shared types stored within this one. All changes are batched and eventually triggered
/// during transaction commit phase.
/// Returns an `YEventObserver` which, when free'd, will unsubscribe current callback.
#[wasm_bindgen(js_name = observeDeep)]
pub fn observe_deep(&self, f: js_sys::Function) -> crate::Result<Observer> {
match &self.0 {
SharedCollection::Prelim(_) => {
Err(JsValue::from_str(crate::js::errors::INVALID_PRELIM_OP))
}
SharedCollection::Integrated(c) => {
let txn = c.transact()?;
let array = c.resolve(&txn)?;
Ok(Observer(array.observe_deep(move |txn, e| {
let e = crate::js::convert::events_into_js(txn, e);
let txn = YTransaction::from_ref(txn);
f.call2(&JsValue::UNDEFINED, &e, &txn.into()).unwrap();
})))
}
}
}
}
/// Event generated by `YYText.observe` method. Emitted during transaction commit phase.
#[wasm_bindgen]
pub struct YTextEvent {
inner: &'static TextEvent,
txn: &'static TransactionMut<'static>,
target: Option<JsValue>,
delta: Option<JsValue>,
}
#[wasm_bindgen]
impl YTextEvent {
pub(crate) fn new<'doc>(event: &TextEvent, txn: &TransactionMut<'doc>) -> Self {
let inner: &'static TextEvent = unsafe { std::mem::transmute(event) };
let txn: &'static TransactionMut<'static> = unsafe { std::mem::transmute(txn) };
YTextEvent {
inner,
txn,
target: None,
delta: None,
}
}
/// Returns an array of keys and indexes creating a path from root type down to current instance
/// of shared type (accessible via `target` getter).
#[wasm_bindgen]
pub fn path(&self) -> JsValue {
crate::js::convert::path_into_js(self.inner.path())
}
/// Returns a current shared type instance, that current event changes refer to.
#[wasm_bindgen(getter)]
pub fn target(&mut self) -> JsValue {
let target = self.inner.target();
let doc = self.txn.doc();
let js = self.target.get_or_insert_with(|| {
YText(SharedCollection::integrated(target.clone(), doc.clone())).into()
});
js.clone()
}
#[wasm_bindgen(getter)]
pub fn origin(&mut self) -> JsValue {
let origin = self.txn.origin();
if let Some(origin) = origin {
Js::from(origin).into()
} else {
JsValue::UNDEFINED
}
}
/// Returns a list of text changes made over corresponding `YText` collection within
/// bounds of current transaction. These changes follow a format:
///
/// - { insert: string, attributes: any|undefined }
/// - { delete: number }
/// - { retain: number, attributes: any|undefined }
#[wasm_bindgen(getter)]
pub fn delta(&mut self) -> crate::Result<JsValue> {
if let Some(delta) = &self.delta {
Ok(delta.clone())
} else {
let result = js_sys::Array::new();
let txn = self.txn;
for d in self.inner.delta(txn) {
let delta = crate::js::convert::text_delta_into_js(d, txn.doc())?;
result.push(&delta);
}
let delta: JsValue = result.into();
self.delta = Some(delta.clone());
Ok(delta)
}
}
}