Make React ProseMirror optional for Presence (#43)

Exposes two plugins, one using vanilla ProseMirror View decorations and one using React-based ones. The React plugin is exported via @pitter-patter/presence-client/react, and so will be ignored if that path is never imported. This allows clients that are not using React ProseMirror to use Presence, without needing to install the (now optional) React, React DOM, and React ProseMirror peer dependencies.

Author: smoores-dev

.yarn/versions/30636284.yml

@@ -0,0 +1,2 @@
+releases:
+  "@pitter-patter/presence-client": minor

packages/demo/src/editor/Editor.tsx

@@ -15,12 +15,12 @@ import {
   collab,
 } from "@pitter-patter/collab-client";
 import {
-  presence,
   PresenceClient,
   receivePresenceTransaction,
   LongPollListener as PresenceLongPollListener,
   PresenceClientConfig,
 } from "@pitter-patter/presence-client";
+import { presence } from "@pitter-patter/presence-client/react";
 import {
   Snapshot,
   VersionHistoryClient,

…ocs/content/docs/presence/quick-start.md …cs/content/docs/presence/quick-start.mdxpackages/docs/content/docs/presence/quick-start.md renamed to packages/docs/content/docs/presence/quick-start.mdx packages/docs/content/docs/presence/quick-start.md renamed to packages/docs/content/docs/presence/quick-start.mdx

@@ -65,6 +65,12 @@ app.post("/api/docs/:docId/presence", async (req, res) => {
 
 ## Configure your frontend
 
+<Callout title="Using React?" type="idea">
+  If you’re using `@handlewithcare/react-prosemirror` to render your ProseMirror editor with React,
+  you should import the `presence` plugin from `@pitter-patter/presence-client/react`, instead of
+  `@pitter-patter/presence-client`!
+</Callout>
+
 ```npm
 npm i @pitter-patter/presence-client
 ```

packages/docs/content/docs/presence/reference/presence-client/README.md

@@ -4,23 +4,7 @@ title: "@pitter-patter/presence-client"
 
 # @pitter-patter/presence-client
 
-## Classes
+## Modules
 
-- [LongPollListener](/docs/presence/reference/presence-client/classes/LongPollListener)
-- [PresenceClient](/docs/presence/reference/presence-client/classes/PresenceClient)
-
-## Interfaces
-
-- [IndicatorListener](/docs/presence/reference/presence-client/interfaces/IndicatorListener)
-- [LongPollListenerOptions](/docs/presence/reference/presence-client/interfaces/LongPollListenerOptions)
-- [PresenceClientConfig](/docs/presence/reference/presence-client/interfaces/PresenceClientConfig)
-- [PresenceIndicator](/docs/presence/reference/presence-client/interfaces/PresenceIndicator)
-
-## Variables
-
-- [presenceKey](/docs/presence/reference/presence-client/variables/presenceKey)
-
-## Functions
-
-- [presence](/docs/presence/reference/presence-client/functions/presence)
-- [receivePresenceTransaction](/docs/presence/reference/presence-client/functions/receivePresenceTransaction)
+- [index](/docs/presence/reference/presence-client/index/README)
+- [react](/docs/presence/reference/presence-client/react/README)

packages/docs/content/docs/presence/reference/presence-client/functions/presence.md

@@ -0,0 +1,27 @@
+---
+title: index
+---
+
+# index
+
+## Classes
+
+- [LongPollListener](/docs/presence/reference/presence-client/index/classes/LongPollListener)
+- [PresenceClient](/docs/presence/reference/presence-client/index/classes/PresenceClient)
+
+## Interfaces
+
+- [IndicatorListener](/docs/presence/reference/presence-client/index/interfaces/IndicatorListener)
+- [LongPollListenerOptions](/docs/presence/reference/presence-client/index/interfaces/LongPollListenerOptions)
+- [PresenceClientConfig](/docs/presence/reference/presence-client/index/interfaces/PresenceClientConfig)
+- [PresenceIndicator](/docs/presence/reference/presence-client/index/interfaces/PresenceIndicator)
+- [PresenceState](/docs/presence/reference/presence-client/index/interfaces/PresenceState)
+
+## Variables
+
+- [presence](/docs/presence/reference/presence-client/index/variables/presence)
+- [presenceKey](/docs/presence/reference/presence-client/index/variables/presenceKey)
+
+## Functions
+
+- [receivePresenceTransaction](/docs/presence/reference/presence-client/index/functions/receivePresenceTransaction)

packages/docs/content/docs/presence/reference/presence-client/index/README.md

@@ -5,11 +5,11 @@ title: LongPollListener
 # Class: LongPollListener
 
 Defined in:
-[index.ts:121](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L121)
+[index.ts:116](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L116)
 
-An [IndicatorListener](/docs/presence/reference/presence-client/interfaces/IndicatorListener) that
-polls an endpoint for remote updates to a document's presence state. Intended to be used with an
-remote long polling endpoint that call a Presence Authority's
+An [IndicatorListener](/docs/presence/reference/presence-client/index/interfaces/IndicatorListener)
+that polls an endpoint for remote updates to a document's presence state. Intended to be used with
+an remote long polling endpoint that call a Presence Authority's
 [listenForPresence](https://pitter-patter.dev/docs/presence/reference/presence-server/classes/PresenceAuthority#listenforpresence)
 function to efficiently listen for updates.
 
@@ -22,7 +22,7 @@ new LongPollListener(url: URL, options?: LongPollListenerOptions): LongPollListe
 ```
 
 Defined in:
-[index.ts:128](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L128)
+[index.ts:123](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L123)
 
 #### Parameters
 
@@ -34,7 +34,7 @@ the url that polling requests will be sent to
 
 ##### options?
 
-[`LongPollListenerOptions`](/docs/presence/reference/presence-client/interfaces/LongPollListenerOptions)
+[`LongPollListenerOptions`](/docs/presence/reference/presence-client/index/interfaces/LongPollListenerOptions)
 = `{}`
 
 #### Returns
@@ -52,7 +52,7 @@ listen(clientId: string, options?: {
 ```
 
 Defined in:
-[index.ts:143](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L143)
+[index.ts:138](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L138)
 
 #### Parameters
 
@@ -69,7 +69,7 @@ Defined in:
 #### Returns
 
 `AsyncGenerator`\<`Record`\<`string`,
-[`PresenceIndicator`](/docs/presence/reference/presence-client/interfaces/PresenceIndicator)\>,
+[`PresenceIndicator`](/docs/presence/reference/presence-client/index/interfaces/PresenceIndicator)\>,
 `void`, `unknown`\>
 
 ---
@@ -81,7 +81,7 @@ update(headers: Record<string, string>): void;
 ```
 
 Defined in:
-[index.ts:139](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L139)
+[index.ts:134](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L134)
 
 Update the headers sent with long polling requests.
 

…sence-client/classes/LongPollListener.md …client/index/classes/LongPollListener.mdpackages/docs/content/docs/presence/reference/presence-client/classes/LongPollListener.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/classes/LongPollListener.md packages/docs/content/docs/presence/reference/presence-client/classes/LongPollListener.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/classes/LongPollListener.md

@@ -5,7 +5,7 @@ title: PresenceClient
 # Class: PresenceClient
 
 Defined in:
-[index.ts:24](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L24)
+[index.ts:19](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L19)
 
 The client that manages sending local presence state to the remote server and listening for remote
 changes to presence state.
@@ -19,13 +19,13 @@ new PresenceClient(config: PresenceClientConfig): PresenceClient;
 ```
 
 Defined in:
-[index.ts:33](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L33)
+[index.ts:28](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L28)
 
 #### Parameters
 
 ##### config
 
-[`PresenceClientConfig`](/docs/presence/reference/presence-client/interfaces/PresenceClientConfig)
+[`PresenceClientConfig`](/docs/presence/reference/presence-client/index/interfaces/PresenceClientConfig)
 
 #### Returns
 
@@ -40,7 +40,7 @@ listen(signal?: AbortSignal): Promise<void>;
 ```
 
 Defined in:
-[index.ts:93](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L93)
+[index.ts:88](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L88)
 
 Start listening for remote presence changes. This function should only be called once.
 
@@ -63,7 +63,7 @@ send(editorState: EditorState): Promise<void>;
 ```
 
 Defined in:
-[index.ts:44](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L44)
+[index.ts:39](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L39)
 
 Send updated presence state to the remote PresenceAuthority.
 
@@ -86,7 +86,7 @@ update(config: Partial<Omit<PresenceClientConfig, "listener">>): void;
 ```
 
 Defined in:
-[index.ts:85](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L85)
+[index.ts:80](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/index.ts#L80)
 
 Updates the desired portion of the client's `PresenceClientConfig`. For example, this can be used to
 update the auth headers used by `send`.
@@ -95,7 +95,7 @@ update the auth headers used by `send`.
 
 ##### config
 
-`Partial`\<`Omit`\<[`PresenceClientConfig`](/docs/presence/reference/presence-client/interfaces/PresenceClientConfig),
+`Partial`\<`Omit`\<[`PresenceClientConfig`](/docs/presence/reference/presence-client/index/interfaces/PresenceClientConfig),
 `"listener"`\>\>
 
 #### Returns

…resence-client/classes/PresenceClient.md …e-client/index/classes/PresenceClient.mdpackages/docs/content/docs/presence/reference/presence-client/classes/PresenceClient.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/classes/PresenceClient.md packages/docs/content/docs/presence/reference/presence-client/classes/PresenceClient.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/classes/PresenceClient.md

@@ -11,8 +11,7 @@ function receivePresenceTransaction(
 ): Transaction;
 ```
 
-Defined in:
-[plugin.ts:23](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/plugin.ts#L23)
+Defined in: basePlugin.ts:19
 
 Merges updated presence indicators into an editor state.
 
@@ -25,7 +24,7 @@ Merges updated presence indicators into an editor state.
 ### presence
 
 `Record`\<`string`,
-[`PresenceIndicator`](/docs/presence/reference/presence-client/interfaces/PresenceIndicator)\>
+[`PresenceIndicator`](/docs/presence/reference/presence-client/index/interfaces/PresenceIndicator)\>
 
 ## Returns
 

…/functions/receivePresenceTransaction.md …/functions/receivePresenceTransaction.mdpackages/docs/content/docs/presence/reference/presence-client/functions/receivePresenceTransaction.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/functions/receivePresenceTransaction.md packages/docs/content/docs/presence/reference/presence-client/functions/receivePresenceTransaction.md renamed to packages/docs/content/docs/presence/reference/presence-client/index/functions/receivePresenceTransaction.md

@@ -5,7 +5,7 @@ title: IndicatorListener
 # Interface: IndicatorListener
 
 Defined in:
-[index.ts:13](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L13)
+[config.ts:3](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/config.ts#L3)
 
 ## Properties
 
@@ -21,7 +21,7 @@ listen: (
 ```
 
 Defined in:
-[index.ts:14](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/presence-client/src/index.ts#L14)
+[config.ts:4](https://github.com/handlewithcarecollective/pitter-patter/blob/5d0afded00b080a66ff242336c2afe1d7fdbb5a7/packages/presence-client/src/config.ts#L4)
 
 #### Parameters
 
@@ -38,4 +38,4 @@ Defined in:
 #### Returns
 
 `AsyncIterableIterator`\<`Record`\<`string`,
-[`PresenceIndicator`](/docs/presence/reference/presence-client/interfaces/PresenceIndicator)\>\>
+[`PresenceIndicator`](/docs/presence/reference/presence-client/index/interfaces/PresenceIndicator)\>\>