@pm-cm/yjs 0.0.12 → 0.0.13

package/dist/index.d.cts

@@ -101,6 +101,12 @@ type ReplaceTextResult = {
 } | {
     ok: false;
     reason: 'serialize-error';
+} | {
+    ok: false;
+    reason: 'skip-pending';
+} | {
+    ok: false;
+    reason: 'parse-failed';
 };
 /** Result of {@link replaceSharedProseMirror}. */
 type ReplaceProseMirrorResult = {
@@ -207,6 +213,15 @@ type CollabPluginsOptions = {
     yCursorPluginOpts?: YCursorPluginOpts;
     /** Extra options forwarded to `yUndoPlugin`. */
     yUndoPluginOpts?: YUndoPluginOpts;
+    /**
+     * When `true`, the bridge sync plugin calls `bridge.dispose()` when
+     * the last plugin instance for this bridge is destroyed. Default `false`.
+     *
+     * Enable this only when the factory owns the bridge lifecycle.
+     * When the caller creates and manages the bridge separately, leave
+     * this `false` and call `bridge.dispose()` manually.
+     */
+    autoDisposeBridge?: boolean;
     /** Called for non-fatal warnings. Propagated to child plugins. Default `console.warn`. */
     onWarning?: OnWarning;
 };
@@ -227,7 +242,7 @@ type BridgeSyncState = {
 };
 type BridgeSyncFailure = {
     ok: false;
-    reason: 'detached' | 'serialize-error';
+    reason: 'detached' | 'serialize-error' | 'parse-failed';
 };
 /** Options for {@link createBridgeSyncPlugin}. */
 type BridgeSyncPluginOptions = {
@@ -235,6 +250,11 @@ type BridgeSyncPluginOptions = {
     onSyncFailure?: (result: BridgeSyncFailure, view: EditorView) => void;
     /** Called for non-fatal warnings. Default `console.warn`. */
     onWarning?: OnWarning;
+    /**
+     * When `true`, automatically call `bridge.dispose()` when the last
+     * plugin instance for this bridge is destroyed. Default `false`.
+     */
+    autoDispose?: boolean;
 };
 /** ProseMirror plugin key for {@link createBridgeSyncPlugin}. Use to read the plugin state. */
 declare const bridgeSyncPluginKey: PluginKey<BridgeSyncState>;

package/dist/index.d.ts

@@ -101,6 +101,12 @@ type ReplaceTextResult = {
 } | {
     ok: false;
     reason: 'serialize-error';
+} | {
+    ok: false;
+    reason: 'skip-pending';
+} | {
+    ok: false;
+    reason: 'parse-failed';
 };
 /** Result of {@link replaceSharedProseMirror}. */
 type ReplaceProseMirrorResult = {
@@ -207,6 +213,15 @@ type CollabPluginsOptions = {
     yCursorPluginOpts?: YCursorPluginOpts;
     /** Extra options forwarded to `yUndoPlugin`. */
     yUndoPluginOpts?: YUndoPluginOpts;
+    /**
+     * When `true`, the bridge sync plugin calls `bridge.dispose()` when
+     * the last plugin instance for this bridge is destroyed. Default `false`.
+     *
+     * Enable this only when the factory owns the bridge lifecycle.
+     * When the caller creates and manages the bridge separately, leave
+     * this `false` and call `bridge.dispose()` manually.
+     */
+    autoDisposeBridge?: boolean;
     /** Called for non-fatal warnings. Propagated to child plugins. Default `console.warn`. */
     onWarning?: OnWarning;
 };
@@ -227,7 +242,7 @@ type BridgeSyncState = {
 };
 type BridgeSyncFailure = {
     ok: false;
-    reason: 'detached' | 'serialize-error';
+    reason: 'detached' | 'serialize-error' | 'parse-failed';
 };
 /** Options for {@link createBridgeSyncPlugin}. */
 type BridgeSyncPluginOptions = {
@@ -235,6 +250,11 @@ type BridgeSyncPluginOptions = {
     onSyncFailure?: (result: BridgeSyncFailure, view: EditorView) => void;
     /** Called for non-fatal warnings. Default `console.warn`. */
     onWarning?: OnWarning;
+    /**
+     * When `true`, automatically call `bridge.dispose()` when the last
+     * plugin instance for this bridge is destroyed. Default `false`.
+     */
+    autoDispose?: boolean;
 };
 /** ProseMirror plugin key for {@link createBridgeSyncPlugin}. Use to read the plugin state. */
 declare const bridgeSyncPluginKey: PluginKey<BridgeSyncState>;

package/dist/index.js

@@ -98,6 +98,9 @@ function createYjsBridge(config, options) {
     throw new Error("sharedProseMirror belongs to a different Y.Doc than the provided doc");
   }
   let lastBridgedText = null;
+  let pendingSkipCleanup = null;
+  let skipPending = false;
+  let parseFailed = false;
   const syncTextToProsemirror = (origin) => {
     const text = normalize(sharedText.toString());
     if (lastBridgedText === text) {
@@ -110,6 +113,7 @@ function createYjsBridge(config, options) {
       onError
     });
     if (result.ok) {
+      parseFailed = false;
       let canonical = text;
       if (origin === ORIGIN_INIT) {
         try {
@@ -122,6 +126,9 @@ function createYjsBridge(config, options) {
         }
       }
       lastBridgedText = canonical;
+    } else {
+      parseFailed = true;
+      lastBridgedText = text;
     }
     return result.ok;
   };
@@ -183,13 +190,17 @@ function createYjsBridge(config, options) {
       let parseError = false;
       if (fallbackText.length > 0) {
         replaceSharedText(sharedText, fallbackText, ORIGIN_INIT, normalize);
+        lastBridgedText = normalize(fallbackText);
         const fallbackResult = replaceSharedProseMirror(doc, sharedProseMirror, fallbackText, ORIGIN_INIT, {
           schema,
           parse,
           normalize,
           onError
         });
-        if (!fallbackResult.ok) parseError = true;
+        if (!fallbackResult.ok) {
+          parseError = true;
+          parseFailed = true;
+        }
       }
       return { source: "text", ...parseError && { parseError: true } };
     }
@@ -214,10 +225,57 @@ function createYjsBridge(config, options) {
     }
     if (transactionTouchedXmlFragment(transaction.changed, sharedProseMirror)) {
       lastBridgedText = normalize(sharedText.toString());
+      parseFailed = false;
       return;
     }
     if (skipOrigins !== null && skipOrigins.has(transaction.origin)) {
-      lastBridgedText = normalize(sharedText.toString());
+      const expectedText = normalize(sharedText.toString());
+      lastBridgedText = expectedText;
+      const pmTextNow = sharedProseMirrorToText(sharedProseMirror);
+      if (pmTextNow !== null && normalize(pmTextNow) === expectedText) {
+        parseFailed = false;
+        if (pendingSkipCleanup) pendingSkipCleanup();
+        return;
+      }
+      const xmlTextAtSkipStart = pmTextNow;
+      if (pendingSkipCleanup) pendingSkipCleanup();
+      skipPending = true;
+      let resolved = false;
+      const resolve = () => {
+        if (resolved) return;
+        resolved = true;
+        skipPending = false;
+        sharedProseMirror.unobserveDeep(xmlCatchUpObserver);
+        clearTimeout(timer);
+        pendingSkipCleanup = null;
+      };
+      const xmlCatchUpObserver = (_events, transaction2) => {
+        if (resolved) return;
+        if (skipOrigins.has(transaction2.origin)) {
+          const pmText = sharedProseMirrorToText(sharedProseMirror);
+          if (pmText !== null && normalize(pmText) === expectedText) {
+            parseFailed = false;
+            resolve();
+          }
+        }
+      };
+      const runFallback = () => {
+        resolve();
+        if (lastBridgedText !== expectedText) return;
+        const pmText = sharedProseMirrorToText(sharedProseMirror);
+        if (pmText === null || normalize(pmText) !== expectedText) {
+          const changedDuringSkip = xmlTextAtSkipStart !== null && pmText !== null && normalize(pmText) !== normalize(xmlTextAtSkipStart) || xmlTextAtSkipStart === null && pmText !== null || xmlTextAtSkipStart !== null && pmText === null;
+          if (changedDuringSkip) {
+            lastBridgedText = pmText !== null ? normalize(pmText) : lastBridgedText;
+            return;
+          }
+          lastBridgedText = null;
+          syncTextToProsemirror(ORIGIN_TEXT_TO_PM);
+        }
+      };
+      const timer = setTimeout(runFallback, 500);
+      sharedProseMirror.observeDeep(xmlCatchUpObserver);
+      pendingSkipCleanup = resolve;
       return;
     }
     syncTextToProsemirror(ORIGIN_TEXT_TO_PM);
@@ -227,6 +285,12 @@ function createYjsBridge(config, options) {
   return {
     bootstrapResult,
     syncToSharedText(doc2) {
+      if (skipPending) {
+        return { ok: false, reason: "skip-pending" };
+      }
+      if (parseFailed) {
+        return { ok: false, reason: "parse-failed" };
+      }
       let text;
       try {
         text = serialize(doc2);
@@ -246,6 +310,7 @@ function createYjsBridge(config, options) {
     },
     dispose() {
       sharedText.unobserve(textObserver);
+      if (pendingSkipCleanup) pendingSkipCleanup();
     }
   };
 }
@@ -297,7 +362,6 @@ var wiredBridges = /* @__PURE__ */ new WeakMap();
 var defaultOnWarning = (event) => console.warn(`[pm-cm] ${event.code}: ${event.message}`);
 function createBridgeSyncPlugin(bridge, options = {}) {
   const warn = options.onWarning ?? defaultOnWarning;
-  let yjsBatchSeen = false;
   let needsSync = false;
   return new Plugin({
     key: bridgeSyncPluginKey,
@@ -308,10 +372,6 @@ function createBridgeSyncPlugin(bridge, options = {}) {
       apply(tr, _prev) {
         if (!tr.docChanged) return { needsSync };
         if (bridge.isYjsSyncChange(tr)) {
-          yjsBatchSeen = true;
-          return { needsSync };
-        }
-        if (yjsBatchSeen && tr.getMeta("appendedTransaction")) {
           return { needsSync };
         }
         needsSync = true;
@@ -329,6 +389,14 @@ function createBridgeSyncPlugin(bridge, options = {}) {
           if (needsSync) {
             const result = bridge.syncToSharedText(view.state.doc);
             if (!result.ok) {
+              if (result.reason === "skip-pending") {
+                return;
+              }
+              if (result.reason === "parse-failed") {
+                options.onSyncFailure?.(result, view);
+                warn({ code: "sync-failed", message: `bridge sync failed: ${result.reason}` });
+                return;
+              }
               if (result.reason !== "unchanged") {
                 options.onSyncFailure?.(result, view);
                 warn({ code: "sync-failed", message: `bridge sync failed: ${result.reason}` });
@@ -336,12 +404,15 @@ function createBridgeSyncPlugin(bridge, options = {}) {
             }
           }
           needsSync = false;
-          yjsBatchSeen = false;
         },
         destroy() {
           const remaining = (wiredBridges.get(bridge) ?? 1) - 1;
-          if (remaining <= 0) wiredBridges.delete(bridge);
-          else wiredBridges.set(bridge, remaining);
+          if (remaining <= 0) {
+            wiredBridges.delete(bridge);
+            if (options.autoDispose) bridge.dispose();
+          } else {
+            wiredBridges.set(bridge, remaining);
+          }
         }
       };
     }
@@ -387,6 +458,8 @@ function broadcastTextCursor(awareness, cmCursorFieldName, sharedText, textAncho
   awareness.setLocalStateField(cmCursorFieldName, { anchor: relAnchor, head: relHead });
 }
 var defaultOnWarning2 = (event) => console.warn(`[pm-cm] ${event.code}: ${event.message}`);
+var awarenessRefCounts = /* @__PURE__ */ new WeakMap();
+var awarenessFieldNames = /* @__PURE__ */ new WeakMap();
 function createCursorSyncPlugin(options) {
   const { awareness, serialize, sharedText } = options;
   const warn = options.onWarning ?? defaultOnWarning2;
@@ -436,6 +509,17 @@ function createCursorSyncPlugin(options) {
       }
     },
     view(editorView) {
+      const viewCount = awarenessRefCounts.get(awareness) ?? 0;
+      awarenessRefCounts.set(awareness, viewCount + 1);
+      let fieldNames = awarenessFieldNames.get(awareness);
+      if (!fieldNames) {
+        fieldNames = /* @__PURE__ */ new Set();
+        awarenessFieldNames.set(awareness, fieldNames);
+      }
+      fieldNames.add(cursorFieldName);
+      if (sharedText) {
+        fieldNames.add(cmCursorFieldName);
+      }
       let suppressCmReaction = false;
       let lastCmAbsAnchor = -1;
       let lastCmAbsHead = -1;
@@ -468,6 +552,9 @@ function createCursorSyncPlugin(options) {
             lastCmAbsHead = -1;
             return;
           }
+          if (absAnchor.type !== sharedText || absHead.type !== sharedText) {
+            return;
+          }
           if (absAnchor.index === lastCmAbsAnchor && absHead.index === lastCmAbsHead) return;
           const map = getOrBuildMap(editorView.state.doc);
           if (!map) {
@@ -482,12 +569,18 @@ function createCursorSyncPlugin(options) {
           }
           lastCmAbsAnchor = absAnchor.index;
           lastCmAbsHead = absHead.index;
-          cmCursorHandledByListener = true;
+          if (pendingCmCursor != null) {
+            cmCursorHandledByListener = true;
+          }
           const ok = broadcastPmCursor(awareness, cursorFieldName, editorView, pmAnchor, pmHead);
           if (!ok && !warnedSyncPluginMissing) {
             warnedSyncPluginMissing = true;
             warn({ code: "ysync-plugin-missing", message: "ySyncPlugin state not available \u2014 cursor broadcast skipped" });
           }
+        } catch {
+          awareness.setLocalStateField(cursorFieldName, null);
+          lastCmAbsAnchor = -1;
+          lastCmAbsHead = -1;
         } finally {
           inAwarenessHandler = false;
         }
@@ -528,6 +621,9 @@ function createCursorSyncPlugin(options) {
                 }
               } else {
                 awareness.setLocalStateField(cursorFieldName, null);
+                if (sharedText?.doc) {
+                  awareness.setLocalStateField(cmCursorFieldName, null);
+                }
               }
             }
             cmCursorHandledByListener = false;
@@ -562,9 +658,18 @@ function createCursorSyncPlugin(options) {
           if (sharedText) {
             awareness.off("update", handleAwarenessUpdate);
           }
-          awareness.setLocalStateField(cursorFieldName, null);
-          if (sharedText) {
-            awareness.setLocalStateField(cmCursorFieldName, null);
+          const remaining = (awarenessRefCounts.get(awareness) ?? 1) - 1;
+          if (remaining <= 0) {
+            awarenessRefCounts.delete(awareness);
+            const fields = awarenessFieldNames.get(awareness);
+            if (fields) {
+              for (const field of fields) {
+                awareness.setLocalStateField(field, null);
+              }
+              awarenessFieldNames.delete(awareness);
+            }
+          } else {
+            awarenessRefCounts.set(awareness, remaining);
           }
         }
       };
@@ -605,7 +710,10 @@ function createCollabPlugins(schema, options) {
     yUndoPlugin(options.yUndoPluginOpts)
   ];
   if (options.bridge) {
-    plugins.push(createBridgeSyncPlugin(options.bridge, { onWarning: options.onWarning }));
+    plugins.push(createBridgeSyncPlugin(options.bridge, {
+      onWarning: options.onWarning,
+      autoDispose: options.autoDisposeBridge
+    }));
   }
   if (enableCursorSync && options.serialize) {
     plugins.push(