lexxy-realtime 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 992aeb83b159a49fae25e6e6897b120e288ad7f497352aa0580cc76d0d548d4e
-  data.tar.gz: aa54afbad36600e60da26c0db20bd619381bcf8ee499817ef5111dbfa32cfd91
+  metadata.gz: 444a86a830537d630ccb1247fc6a601b84e30498c5e38d8ca5ce789e095117a6
+  data.tar.gz: 4373eae50d13855bf9895cc505ab323e2949bb73a90aa80d50888e9df4d14be2
 SHA512:
-  metadata.gz: 89100b1162553474b8ee6f795d9f782b7ca1623a9ae62d77460b9a1edd1411d8b23fd404a16e114dcbe289b0091153a10f7ccfdc8c66dec089203a283e351dad
-  data.tar.gz: eb7eed40ea71ebd9fe6b8ce872e8b18373ad3f34a352468a7a9f4fffd06d5cd9cd23d255313a95b2afd74bf3a452b47c13afb49b4ed3a64245fbe04e0a538697
+  metadata.gz: 23d8d6e07ccd5af9548f0bab391f4b91b1673fabc4a6e5f51d9ce9b4a7777f3abde513e01ebce95afab2b1c2c3b941fe9b9c3a140086f9f99648253f26c00d86
+  data.tar.gz: c782da01923dbd52a49016f4971d3f6309c3bd0074705b461c8c6cf028d6a7216a2316bc63dfb6b9e621f5b75f5cfaaf5a4e64a3e0c74e127cc03680164b70d7

data/README.md

@@ -110,9 +110,11 @@ turn the setting off again. The gem doesn't include a task for this.
 
 The channel saves each CRDT update, renders the full document with
 `Y::Lexxy`, and saves the HTML through the Action Text writer. This
-happens in `refresh_collaborative_rich_text`, inside the channel's handler
-for each update. There's no background job, so `post.body` is up to date as
-soon as the channel finishes handling the update.
+happens in `post.collaborative_document(:body).refresh`, inside the
+channel's handler for each update. There's no background job, so
+`post.body` is up to date as soon as the channel finishes handling the
+update. An edit from Ruby, `post.collaborative_document(:body).edit`,
+renders the body the same way.
 
 If rendering fails, the channel logs the error and keeps the update. The
 next update renders the full document again. Until then, `post.body`
@@ -166,14 +168,17 @@ subscription is rejected:
 # app/controllers/posts_controller.rb
 def grant
   @post = current_user.posts.find(params[:id]) # your own authorization, again
-  render json: { grant: @post.collaborative_rich_text_grant(:body, expires_in: 10.minutes) }
+  render json: { grant: @post.collaborative_document(:body).grant(expires_in: 10.minutes) }
 end
 ```
 
-`collaborative_rich_text_grant` makes the same grant the form helper
-renders, for `LexxyRealtime::DocumentChannel`. A grant from yrby-rails'
-`collaborative_sgid` doesn't work here, because the channel checks a
-different purpose.
+For a field declared with `has_collaborative_rich_text`,
+`collaborative_document(:body)` returns this gem's document. Its `grant` is
+the one the form helper renders, its `channel` is
+`LexxyRealtime::DocumentChannel`, `edit` changes the document from Ruby and
+renders the body, and `refresh` renders the body on demand. Code that takes
+a yrby-rails document, such as `collaborative_document_tag`, gets this
+gem's grant and channel for the field.
 
 That action grants write access, so its check must be at least as strict
 as the page that renders the form. If it skips authorization, anyone who

data/app/assets/javascript/lexxy_realtime/yrby-client.js

@@ -1317,6 +1317,12 @@ var ActionCableProvider = class {
 	#resolveSynced;
 	#onDocUpdate = () => this.#refreshStatus();
 	#page = null;
+	#presence = null;
+	#onAwarenessUpdate = ({ added, updated, removed }) => {
+		if (this.#state.phase !== "disconnected") return;
+		const id = this.awareness.clientID;
+		if (added.includes(id) || updated.includes(id) || removed.includes(id)) this.#presence = null;
+	};
 	/**
 	* Resolves once the document has first caught up with the server. Most
 	* editor bindings seed an empty document when they mount, so binding
@@ -1349,6 +1355,7 @@ var ActionCableProvider = class {
 			}
 		};
 		this.awareness = new ProviderAwareness(doc, this.#onError);
+		this.awareness.on("update", this.#onAwarenessUpdate);
 		this.session = new YProtocolSession(doc, {
 			awareness: this.awareness,
 			resendInterval: opts.resendInterval,
@@ -1397,6 +1404,10 @@ var ActionCableProvider = class {
 			phase: "subscribing",
 			attempt
 		};
+		const presence = this.#presence;
+		this.#presence = null;
+		if (presence) this.awareness.setLocalState(presence);
+		if (!this.#subscribing(attempt)) return;
 		const on = (callback) => (...args) => {
 			const run = () => {
 				if (this.#active(attempt)) callback(...args);
@@ -1499,6 +1510,7 @@ var ActionCableProvider = class {
 			};
 			this.#state = stopping;
 			this.#unwatchPage();
+			this.#presence = this.awareness.getLocalState();
 			this.session.removeLocalAwareness();
 			this.session.pause();
 			this.#unsubscribe(state.subscription);
@@ -1514,6 +1526,7 @@ var ActionCableProvider = class {
 	}
 	#destroyOwned() {
 		this.session.destroy();
+		this.awareness.off("update", this.#onAwarenessUpdate);
 		this.awareness.destroy();
 		this.doc.off("update", this.#onDocUpdate);
 	}