Group together user settings

Automattic · Jul 31, 2021 · ad79f6b · ad79f6b
1 parent 464c6da
commit ad79f6b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/src/components/block-editor-contents/use-yjs.js b/src/components/block-editor-contents/use-yjs.js
@@ -44,7 +44,6 @@ async function initYDoc( { blocks, onRemoteDataChange, settings, getSelection, s
 
 	/** @type string */
 	const identity = uuidv4();
-	const caretColor = settings.caretColor || sample( defaultColors );
 
 	debug( `initYDoc (identity: ${ identity })` );
 
@@ -93,9 +92,11 @@ async function initYDoc( { blocks, onRemoteDataChange, settings, getSelection, s
 
 	return transport
 		.connect( {
-			identity,
-			username: settings.username,
-			caretColor,
+			user: {
+				identity,
+				name: settings.username,
+				color: settings.caretColor || sample( defaultColors ),
+			},
 			onReceiveMessage,
 			setAvailablePeers: ( peers ) => {
 				debug( 'setAvailablePeers', peers );

diff --git a/src/index.js b/src/index.js
@@ -111,9 +111,10 @@ import './style.scss';
  * @property {() => Promise<void>} disconnect
  *
  * @typedef CollaborationTransportConnectOpts
- * @property {string} identity
- * @property {string} username
- * @property {string} caretColor Color of the caret indicator displayed to peers.
+ * @property {object} user
+ * @property {string} user.identity
+ * @property {string} user.name
+ * @property {string} user.color Color of the caret indicator displayed to peers.
  * @property {(message: object) => void} onReceiveMessage Callback to run when a message is received.
  * @property {(peers: AvailablePeer[]) => void} setAvailablePeers Callback to run when peers change.
  * @property {string} [channelId]

diff --git a/stories/collab/mock-transport.js b/stories/collab/mock-transport.js
@@ -6,7 +6,7 @@ const mockTransport = {
 	sendMessage: ( data ) => {
 		window.localStorage.setItem( 'isoEditorYjsMessage', JSON.stringify( data ) );
 	},
-	connect: ( { identity, username, caretColor, onReceiveMessage, setAvailablePeers, channelId } ) => {
+	connect: ( { user: { identity, name, color }, onReceiveMessage, setAvailablePeers, channelId } ) => {
 		listeners.push(
 			{
 				event: 'storage',
@@ -39,7 +39,7 @@ const mockTransport = {
 
 		window.localStorage.setItem(
 			'isoEditorYjsPeers',
-			JSON.stringify( [ ...peers, { id: identity, name: username, color: caretColor } ] )
+			JSON.stringify( [ ...peers, { id: identity, name, color } ] )
 		);
 
 		disconnectHandlers.push( () => {