@ai-matrx/office 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.8.0
+
+Docs co-editing on the ordered log (COLLAB-DESIGN unit C3), in `./univer/collab` (loaded on demand):
+
+- `transformDocsOp(x, y, side)` → `{ op, lost }`: ot-json1 `transformNoConflict` with our text-x transform. Rules R1–R5 from the C0b spike plus R6 (a merge retain whose style lost every key becomes a plain retain; REPLACE retains untouched). `composeDocsOps`, `invertDocsOp` (inverts a copy: `invertWithDoc` mutates its op), `normalizeDocsOp`, `applyDocsOp`. New dependency `ot-json1` (already in the graph through `@univerjs/core`).
+- `docsStateHash(snapshot)` (Web Crypto SHA-256 of `canonicalDocsSnapshot`) and `stampDeterministicIds` for raw snapshots.
+- `openDocsOtRoom({ port, transport, clientId, presence, replace, onNotice })`: capture of applied rich-text mutations with their pre-state inverse and command label, remote apply with `fromCollab` (unit re-addressed, `textRanges: null`, `noNeedSetTextRange`), an IME composition queue, undo/redo items rebased over every remote op (undo reverts only your own change), saves only from the chosen quiet seat with a matching hash, restore through `collab_replace`. Page setup is a barrier (§18).
+- `DocumentModel.startOtRoom(factory)`, `collabMode()`, and the view port's optional `undoRedo`. Command depth per view is closed in a try/finally around `executeCommand`. `write`, `replaceContent` and `rest` route to the room when one is open.
+- `documentOtFactory({ documentId, uid, clientId, onNotice, … })` and `documentUsesOrderedRoom(documentId, knob, isNew)`: the room for a cloud document (store `udt_document_snapshots`, doors over the docs host's client, Yjs awareness for presence and `quiet_hash` only).
+- Evidence: the §6.4 property over the three C0 corpora, the eight owner-ruled pairs, 20,000 seeds each: 0 divergences, 0 throws; Univer's own transform diverges on the same draws (red). `DOCS_OT_FUZZ_SEEDS=20000 pnpm vitest run src/univer/collab/docs-ot/concurrent-docs-edits-converge.test.ts` (default run: 2,000 seeds).
+
+### Consumer action
+
+Wire `model.startOtRoom(documentOtFactory(...))` for documents where `documentUsesOrderedRoom` is true; the 0.6 relay stays the path for every other document.
+
 ## 0.7.0
 
 New `./collab/sheets-transform` entry: the co-editing transformer for workbook edits (COLLAB-DESIGN unit C5a). Pure functions, no runtime wiring: nothing calls it until the Sheets flip (C6).

package/dist/docs.cjs

@@ -45,6 +45,9 @@ function takeCovered(snapshot) {
 }
 
 // src/docs/document-model.ts
+var RICH_TEXT_EDITING_ID = "doc.mutation.rich-text-editing";
+var COMMAND_TYPE = 0;
+var DEPTH_GUARDED = /* @__PURE__ */ Symbol.for("ai-matrx.office.docs.command-depth-guard");
 var DOCUMENT_SAVE_DELAY_MS = 2500;
 var viewIds = 0;
 var DocumentModel = (_class = class {
@@ -61,17 +64,21 @@ var DocumentModel = (_class = class {
   __init6() {this.knownSnapshots = /* @__PURE__ */ new Set()}
   __init7() {this.collabListeners = /* @__PURE__ */ new Set()}
   __init8() {this.collab = null}
+  /** The ordered-log room (C3); exclusive with `collab` (the 0.6 relay room). */
+  __init9() {this.ot = null}
+  __init10() {this.otStarting = null}
+  __init11() {this.otListeners = /* @__PURE__ */ new Set()}
   /** The saved snapshot the body started from, and the room entries it already holds. */
-  __init9() {this.baseId = null}
-  __init10() {this.baseCovered = /* @__PURE__ */ new Set()}
-  __init11() {this.collabStarting = null}
-  __init12() {this.awareness = null}
-  __init13() {this.awarenessListeners = /* @__PURE__ */ new Set()}
-  __init14() {this.realtimeClose = null}
-  __init15() {this.pageClose = null}
+  __init12() {this.baseId = null}
+  __init13() {this.baseCovered = /* @__PURE__ */ new Set()}
+  __init14() {this.collabStarting = null}
+  __init15() {this.awareness = null}
+  __init16() {this.awarenessListeners = /* @__PURE__ */ new Set()}
+  __init17() {this.realtimeClose = null}
+  __init18() {this.pageClose = null}
   /** The last view's editor, alive and off the page until a view takes it back. */
-  __init16() {this.parked = null}
-  constructor(handle, deps) {;_class.prototype.__init.call(this);_class.prototype.__init2.call(this);_class.prototype.__init3.call(this);_class.prototype.__init4.call(this);_class.prototype.__init5.call(this);_class.prototype.__init6.call(this);_class.prototype.__init7.call(this);_class.prototype.__init8.call(this);_class.prototype.__init9.call(this);_class.prototype.__init10.call(this);_class.prototype.__init11.call(this);_class.prototype.__init12.call(this);_class.prototype.__init13.call(this);_class.prototype.__init14.call(this);_class.prototype.__init15.call(this);_class.prototype.__init16.call(this);_class.prototype.__init17.call(this);_class.prototype.__init18.call(this);_class.prototype.__init19.call(this);_class.prototype.__init20.call(this);
+  __init19() {this.parked = null}
+  constructor(handle, deps) {;_class.prototype.__init.call(this);_class.prototype.__init2.call(this);_class.prototype.__init3.call(this);_class.prototype.__init4.call(this);_class.prototype.__init5.call(this);_class.prototype.__init6.call(this);_class.prototype.__init7.call(this);_class.prototype.__init8.call(this);_class.prototype.__init9.call(this);_class.prototype.__init10.call(this);_class.prototype.__init11.call(this);_class.prototype.__init12.call(this);_class.prototype.__init13.call(this);_class.prototype.__init14.call(this);_class.prototype.__init15.call(this);_class.prototype.__init16.call(this);_class.prototype.__init17.call(this);_class.prototype.__init18.call(this);_class.prototype.__init19.call(this);_class.prototype.__init20.call(this);_class.prototype.__init21.call(this);_class.prototype.__init22.call(this);_class.prototype.__init23.call(this);_class.prototype.__init24.call(this);
     this.documentId = handle.id;
     this.handle = handle;
     this.deps = deps;
@@ -124,7 +131,14 @@ var DocumentModel = (_class = class {
     const subscription = port.commandService.onMutationExecutedForCollab(
       (info, options) => this.onViewMutation(id, info, options)
     );
-    this.views.set(id, { id, port, dispose: () => subscription.dispose() });
+    const view = { id, port, dispose: () => {
+    }, commands: [], pre: null };
+    const hooks = this.trackCommands(view);
+    view.dispose = () => {
+      subscription.dispose();
+      hooks();
+    };
+    this.views.set(id, view);
     if (!this.handle.hasPending()) {
       try {
         const mounted = port.snapshot();
@@ -137,8 +151,8 @@ var DocumentModel = (_class = class {
     return () => {
       if (detached) return;
       detached = true;
-      const view = this.views.get(id);
-      if (!view) return;
+      const view2 = this.views.get(id);
+      if (!view2) return;
       if (this.views.size === 1) {
         try {
           const snapshot = port.snapshot();
@@ -147,7 +161,7 @@ var DocumentModel = (_class = class {
           console.warn(`[document-model] could not keep ${this.documentId}'s last view's document`, error);
         }
       }
-      view.dispose();
+      view2.dispose();
       this.views.delete(id);
       if (this.lastEditedView === id) this.lastEditedView = null;
     };
@@ -171,19 +185,74 @@ var DocumentModel = (_class = class {
     return editor;
   }
   onViewMutation(viewId, info, options) {
-    if (this.relaying || _optionalChain([options, 'optionalAccess', _ => _.fromCollab]) || _optionalChain([options, 'optionalAccess', _2 => _2.fromChangeset])) return;
+    if (this.relaying || _optionalChain([options, 'optionalAccess', _7 => _7.fromCollab]) || _optionalChain([options, 'optionalAccess', _8 => _8.fromChangeset])) return;
     const view = this.views.get(viewId);
     if (!view || !view.port.editable()) return;
     this.lastEditedView = viewId;
     this.relay(info, viewId);
     for (const listener of this.collabListeners) listener(info, options);
+    if (this.otListeners.size && !_optionalChain([options, 'optionalAccess', _9 => _9.onlyLocal])) {
+      const m = {
+        id: info.id,
+        params: info.params,
+        pre: info.id === RICH_TEXT_EDITING_ID ? view.pre : null,
+        cmd: _nullishCoalesce(view.commands[0], () => ( null)),
+        content: isContentMutation(info)
+      };
+      view.pre = null;
+      for (const listener of Array.from(this.otListeners)) listener(m);
+    }
     if (isContentMutation(info)) this.markDirty();
   }
+  /**
+   * Per view: the outermost command running (a mutation's group label) and, while a room listens, the document
+   * before each rich-text mutation (its inverse is computed from the APPLIED actions against this copy). Univer's
+   * `executeCommand` has no `finally`: a command that mutates then throws never fires `onCommandExecuted`, so
+   * the depth is restored in a try/finally around the instance's `executeCommand` (C0 surprise 7).
+   */
+  trackCommands(view) {
+    const cs = view.port.commandService;
+    if (typeof cs.beforeCommandExecuted !== "function" || typeof cs.onCommandExecuted !== "function") return () => {
+    };
+    const before = cs.beforeCommandExecuted((info) => {
+      if (info.type === COMMAND_TYPE) view.commands.push(info.id);
+      else if (info.id === RICH_TEXT_EDITING_ID && this.otListeners.size && !this.relaying) {
+        try {
+          const snap = view.port.snapshot();
+          view.pre = snap ? structuredClone(snap) : null;
+        } catch (e3) {
+          view.pre = null;
+        }
+      }
+    });
+    const after = cs.onCommandExecuted((info) => {
+      if (info.type !== COMMAND_TYPE) return;
+      const at = view.commands.lastIndexOf(info.id);
+      if (at >= 0) view.commands.splice(at, 1);
+    });
+    const guarded = cs;
+    if (typeof cs.executeCommand === "function" && !guarded[DEPTH_GUARDED]) {
+      const original = cs.executeCommand.bind(cs);
+      guarded[DEPTH_GUARDED] = true;
+      cs.executeCommand = async (id, params, options) => {
+        const depth = view.commands.length;
+        try {
+          return await original(id, params, options);
+        } finally {
+          if (view.commands.length > depth) view.commands.length = depth;
+        }
+      };
+    }
+    return () => {
+      before.dispose();
+      after.dispose();
+    };
+  }
   /** The unit id a view's document has (what a replayed mutation must be addressed to). */
   unitIdOf(view) {
     try {
-      return _nullishCoalesce(_nullishCoalesce(_optionalChain([view, 'access', _3 => _3.port, 'access', _4 => _4.unitId, 'optionalCall', _5 => _5()]), () => ( _optionalChain([view, 'access', _6 => _6.port, 'access', _7 => _7.snapshot, 'call', _8 => _8(), 'optionalAccess', _9 => _9.id]))), () => ( null));
-    } catch (e3) {
+      return _nullishCoalesce(_nullishCoalesce(_optionalChain([view, 'access', _10 => _10.port, 'access', _11 => _11.unitId, 'optionalCall', _12 => _12()]), () => ( _optionalChain([view, 'access', _13 => _13.port, 'access', _14 => _14.snapshot, 'call', _15 => _15(), 'optionalAccess', _16 => _16.id]))), () => ( null));
+    } catch (e4) {
       return null;
     }
   }
@@ -216,7 +285,7 @@ var DocumentModel = (_class = class {
   /** A view could not follow an edit: say so, then show the saved version (unless this tab has unsaved edits of its own). */
   applyFailed(mutationId, error) {
     try {
-      _optionalChain([this, 'access', _10 => _10.deps, 'access', _11 => _11.onApplyFailed, 'optionalCall', _12 => _12(this.documentId, mutationId, error)]);
+      _optionalChain([this, 'access', _17 => _17.deps, 'access', _18 => _18.onApplyFailed, 'optionalCall', _19 => _19(this.documentId, mutationId, error)]);
     } catch (notifyError) {
       console.warn(`[document-model] the notice for ${this.documentId}'s failed apply also failed`, notifyError);
     }
@@ -229,19 +298,24 @@ var DocumentModel = (_class = class {
   markDirty() {
     this.handle.touch();
   }
-  __init17() {this.saving = false}
+  __init20() {this.saving = false}
   /**
    * The content of the version the server holds (loaded or last written). A
    * save of the same content is no save: attaching, detaching, waking or a
    * flush of an unchanged document never writes a snapshot row.
    */
-  __init18() {this.savedFingerprint = null}
+  __init21() {this.savedFingerprint = null}
   /**
    * Write the body as it is now. Returns false when this tab is a collab peer
    * that does not write (the elected host writes the canonical snapshot; a
    * peer's edits reach it through the room). An explicit Save always writes.
    */
   async write(reason) {
+    if (this.ot) {
+      const wrote = await this.ot.write(reason);
+      if (wrote) _optionalChain([this, 'access', _20 => _20.deps, 'access', _21 => _21.onSaved, 'optionalCall', _22 => _22(this.documentId, reason === "manual" ? "manual" : "autosave")]);
+      return wrote;
+    }
     const snapshot = this.latest();
     if (!snapshot) throw new Error("There is no open document to save.");
     if (this.collab && !this.collab.isHost() && reason !== "manual") return false;
@@ -264,7 +338,7 @@ var DocumentModel = (_class = class {
       this.saving = false;
     }
     if (this.views.size === 0) this.stored = snapshot;
-    _optionalChain([this, 'access', _13 => _13.deps, 'access', _14 => _14.onSaved, 'optionalCall', _15 => _15(this.documentId, origin)]);
+    _optionalChain([this, 'access', _23 => _23.deps, 'access', _24 => _24.onSaved, 'optionalCall', _25 => _25(this.documentId, origin)]);
     return true;
   }
   hasUnsaved() {
@@ -286,7 +360,7 @@ var DocumentModel = (_class = class {
    * person chooses; `overUnsaved` is "Take theirs" (`./documentModels.ts`).
    */
   async onRemoteSnapshot(snapshotId, { overUnsaved = false } = {}) {
-    if (this.collab) return;
+    if (this.collab || this.ot) return;
     if (this.knownSnapshots.has(snapshotId)) return;
     if (this.saving) return;
     if (this.hasUnsaved() && !overUnsaved) {
@@ -305,8 +379,9 @@ var DocumentModel = (_class = class {
    * room the peers reload it and the shared log is emptied.
    */
   replaceContent(row) {
+    if (this.ot) return this.ot.replace(row.snapshot);
     this.show(row);
-    _optionalChain([this, 'access', _16 => _16.collab, 'optionalAccess', _17 => _17.announceReplaced, 'call', _18 => _18(row.id)]);
+    _optionalChain([this, 'access', _26 => _26.collab, 'optionalAccess', _27 => _27.announceReplaced, 'call', _28 => _28(row.id)]);
   }
   /** A peer replaced the document: show the newest save (once). */
   async onPeerReplaced() {
@@ -329,7 +404,7 @@ var DocumentModel = (_class = class {
     this.relaying = true;
     try {
       for (const view of this.views.values()) view.port.remount(snapshot);
-      _optionalChain([this, 'access', _19 => _19.parked, 'optionalAccess', _20 => _20.remount, 'call', _21 => _21(snapshot)]);
+      _optionalChain([this, 'access', _29 => _29.parked, 'optionalAccess', _30 => _30.remount, 'call', _31 => _31(snapshot)]);
     } finally {
       this.relaying = false;
     }
@@ -340,7 +415,7 @@ var DocumentModel = (_class = class {
    * binds to. Local edits from any view go out once; a peer's edit is applied
    * to every view.
    */
-  __init19() {this.virtualCommandService = {
+  __init22() {this.virtualCommandService = {
     onMutationExecutedForCollab: (listener) => {
       this.collabListeners.add(listener);
       return { dispose: () => this.collabListeners.delete(listener) };
@@ -388,7 +463,79 @@ var DocumentModel = (_class = class {
     }
     return this.collabStarting;
   }
+  /** The model as the ordered-log room sees it (COLLAB-DESIGN §6.7: the model is the client, not the view). */
+  __init23() {this.otPort = {
+    onLocal: (listener) => {
+      this.otListeners.add(listener);
+      return () => void this.otListeners.delete(listener);
+    },
+    applyRemote: (id, params) => {
+      if (this.views.size === 0) throw new Error("no view of the document is mounted");
+      this.relaying = true;
+      try {
+        for (const view of this.views.values()) {
+          const unitId = this.unitIdOf(view);
+          const input = Array.isArray(params.actions) ? params.actions.length : 0;
+          const p = { ...params, ...unitId ? { unitId } : {}, textRanges: null, noNeedSetTextRange: true };
+          const ok = view.port.commandService.syncExecuteCommand(id, p, { onlyLocal: true, fromCollab: true });
+          if (ok === false) throw new Error(`"${id}" was refused by the editor`);
+          if (input > 0 && Array.isArray(p.actions) && p.actions.length === 0) throw new Error(`"${id}" was emptied by the editor`);
+        }
+      } finally {
+        this.relaying = false;
+      }
+      if (isContentMutation({ id, type: 2, params })) this.markDirty();
+    },
+    snapshot: () => this.latest(),
+    load: (snapshot) => {
+      const s2 = snapshot;
+      this.stored = s2;
+      this.savedFingerprint = contentFingerprint(s2);
+      this.relaying = true;
+      try {
+        for (const view of this.views.values()) view.port.remount(s2);
+        _optionalChain([this, 'access', _32 => _32.parked, 'optionalAccess', _33 => _33.remount, 'call', _34 => _34(s2)]);
+      } finally {
+        this.relaying = false;
+      }
+    },
+    undoTargets: () => {
+      const out = [];
+      for (const view of this.views.values()) {
+        const unitId = this.unitIdOf(view);
+        const service = _optionalChain([view, 'access', _35 => _35.port, 'access', _36 => _36.undoRedo, 'optionalCall', _37 => _37()]);
+        if (unitId && service) out.push({ service, unitId });
+      }
+      return out;
+    },
+    markDirty: () => this.markDirty()
+  }}
+  /** Join the document's ordered-log room once (C3). Exclusive with `startCollab`. */
+  startOtRoom(factory) {
+    if (this.ot || this.collab) return Promise.resolve();
+    if (!this.otStarting) {
+      this.otStarting = factory(this.otPort, (awareness) => {
+        this.awareness = awareness;
+        for (const listener of Array.from(this.awarenessListeners)) listener();
+      }).then((handle) => {
+        if (!handle) return;
+        if (this.views.size === 0) {
+          handle.stop();
+          return;
+        }
+        this.ot = handle;
+      }).finally(() => {
+        this.otStarting = null;
+      });
+    }
+    return this.otStarting;
+  }
+  /** Which co-editing room this document is in right now. */
+  collabMode() {
+    return this.ot ? "ordered" : this.collab ? "relay" : null;
+  }
   isCollabHost() {
+    if (this.ot) return this.ot.isSaver();
     return this.collab ? this.collab.isHost() : true;
   }
   getAwareness() {
@@ -414,11 +561,13 @@ var DocumentModel = (_class = class {
    * so a collaborator's save still reaches the body a returning view boots from.
    */
   rest() {
-    _optionalChain([this, 'access', _22 => _22.collab, 'optionalAccess', _23 => _23.stop, 'call', _24 => _24()]);
+    _optionalChain([this, 'access', _38 => _38.collab, 'optionalAccess', _39 => _39.stop, 'call', _40 => _40()]);
     this.collab = null;
+    _optionalChain([this, 'access', _41 => _41.ot, 'optionalAccess', _42 => _42.stop, 'call', _43 => _43()]);
+    this.ot = null;
     this.awareness = null;
   }
-  __init20() {this.closed = false}
+  __init24() {this.closed = false}
   close() {
     this.closed = true;
     const parked = this.parked;
@@ -430,9 +579,9 @@ var DocumentModel = (_class = class {
         console.warn(`[document-model] could not dispose ${this.documentId}'s kept editor`, error);
       }
     }
-    _optionalChain([this, 'access', _25 => _25.realtimeClose, 'optionalCall', _26 => _26()]);
+    _optionalChain([this, 'access', _44 => _44.realtimeClose, 'optionalCall', _45 => _45()]);
     this.realtimeClose = null;
-    _optionalChain([this, 'access', _27 => _27.pageClose, 'optionalCall', _28 => _28()]);
+    _optionalChain([this, 'access', _46 => _46.pageClose, 'optionalCall', _47 => _47()]);
     this.pageClose = null;
   }
 }, _class);