@ai-matrx/office 0.8.17 → 0.8.18

package/dist/univer-collab.d.cts

@@ -252,19 +252,14 @@ declare function invertDocsOp(op: DocsOp, preDoc: unknown): DocsOp;
 /** Part of `proto` (§6.4): Univer 1.0.4 + this transformer, rules R1–R6. */
 declare const DOCS_TRANSFORM_VERSION = "univer-1.0.4+docs-ot-r6";
 
-/**
- * The canonical Docs state hash (COLLAB-DESIGN §7.2; C0 item 6, `spikes/c0-collab/lib.mjs`).
- *
- * SHA-256 of the canonical snapshot: keys sorted, empty values dropped, the unit id and seat-local fields
- * removed (revision counter, collab stamps, layout state, selections), adjacent equal text runs merged, split
- * pieces of one custom range or decoration folded, and `paragraphId` dropped (Univer's TextX.apply mints a
- * random one per seat, C0 surprise 3). Header, footer and note bodies get the same rules.
- *
- * Two seats with equal content hash equal; one character more hashes differently. Browser and Node: the
- * digest is Web Crypto's.
- */
 /** Never content: the collab stamps, revision counters, seat-local view state. */
 declare const DOC_LOCAL_KEYS: string[];
+/**
+ * The snapshot as a seat holds it after loading it: what `DocumentModel` / the editor mount do (deterministic
+ * ids, `sanitizeUniverDocSnapshot`), then Univer's own model normalisation (`createDocumentSnapshot` inside
+ * `DocumentDataModel`). Idempotent: a snapshot a seat saved comes back unchanged in content.
+ */
+declare function asLoadedDocsSnapshot(snapshot: unknown): Record<string, unknown>;
 /** The canonical Docs snapshot: content only, keys sorted, runs normalized, local fields removed. */
 declare function canonicalDocsSnapshot(snapshot: unknown): unknown;
 /** The canonical form as the string the hash digests (tests compare these directly). */
@@ -856,4 +851,4 @@ declare function startWorkbookOtRoom(port: SheetsOtPort & {
     dispose?: () => void;
 }, o: WorkbookOtRoomOptions): Promise<WorkbookOtRoomHandle>;
 
-export { COLLAB_COVERED_KEY, type CollabBase, type CollabMutationInfo, type CollabProviderLike, type CommandServiceLike, DOCS_COLLAB_PROTO, DOCS_TRANSFORM_VERSION, DOC_LOCAL_KEYS, type DocsLocalMutation, type DocsLost, type DocsOp, type DocsOtNotice, type DocsOtPort, type DocsOtRoom, type DocsTransformResult, type DocumentOtFactoryOptions, type DocumentRestoreDeps, type DocumentRestoreResult, type OpenDocsOtRoomOptions, type OpenSheetsOtRoomOptions, type OtRoomsKnob, RICH_TEXT_EDITING, SENDER_VIEW_PARAMS, SHEETS_COLLAB_PROTO, SHEETS_EDIT_GROUP, type SheetOp, type SheetSelection, type SheetsCommandService, type SheetsLocalEvent, type SheetsLocalGroup, type SheetsNotShared, type SheetsOtAdapter, type SheetsOtAdapterHooks, type SheetsOtNotice, type SheetsOtPort, type SheetsOtRoom, type SheetsWorkbookLike, type SheetsWorksheetLike, type UniverSheetsOtPortOptions, WorkbookCollabSession, type WorkbookCollabSessionOptions, type WorkbookOtRoomHandle, type WorkbookOtRoomOptions, type WorkbookOtRoomsKnob, applyDocsOp, canonicalDocsSnapshot, canonicalDocsString, canonicalKeys, canonicalSheet, canonicalSheetString, composeDocsOps, createSheetsOtAdapter, decodeSheetOp, docsStateHash, documentOtFactory, documentUsesOrderedRoom, dropEmptyStyleRetains, encodeSheetOp, invertDocsOp, isCellEditorScratch, isNoopDocsOp, moveSelectionsThrough, normalizeDocsOp, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };
+export { COLLAB_COVERED_KEY, type CollabBase, type CollabMutationInfo, type CollabProviderLike, type CommandServiceLike, DOCS_COLLAB_PROTO, DOCS_TRANSFORM_VERSION, DOC_LOCAL_KEYS, type DocsLocalMutation, type DocsLost, type DocsOp, type DocsOtNotice, type DocsOtPort, type DocsOtRoom, type DocsTransformResult, type DocumentOtFactoryOptions, type DocumentRestoreDeps, type DocumentRestoreResult, type OpenDocsOtRoomOptions, type OpenSheetsOtRoomOptions, type OtRoomsKnob, RICH_TEXT_EDITING, SENDER_VIEW_PARAMS, SHEETS_COLLAB_PROTO, SHEETS_EDIT_GROUP, type SheetOp, type SheetSelection, type SheetsCommandService, type SheetsLocalEvent, type SheetsLocalGroup, type SheetsNotShared, type SheetsOtAdapter, type SheetsOtAdapterHooks, type SheetsOtNotice, type SheetsOtPort, type SheetsOtRoom, type SheetsWorkbookLike, type SheetsWorksheetLike, type UniverSheetsOtPortOptions, WorkbookCollabSession, type WorkbookCollabSessionOptions, type WorkbookOtRoomHandle, type WorkbookOtRoomOptions, type WorkbookOtRoomsKnob, applyDocsOp, asLoadedDocsSnapshot, canonicalDocsSnapshot, canonicalDocsString, canonicalKeys, canonicalSheet, canonicalSheetString, composeDocsOps, createSheetsOtAdapter, decodeSheetOp, docsStateHash, documentOtFactory, documentUsesOrderedRoom, dropEmptyStyleRetains, encodeSheetOp, invertDocsOp, isCellEditorScratch, isNoopDocsOp, moveSelectionsThrough, normalizeDocsOp, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };

package/dist/univer-collab.d.ts

@@ -252,19 +252,14 @@ declare function invertDocsOp(op: DocsOp, preDoc: unknown): DocsOp;
 /** Part of `proto` (§6.4): Univer 1.0.4 + this transformer, rules R1–R6. */
 declare const DOCS_TRANSFORM_VERSION = "univer-1.0.4+docs-ot-r6";
 
-/**
- * The canonical Docs state hash (COLLAB-DESIGN §7.2; C0 item 6, `spikes/c0-collab/lib.mjs`).
- *
- * SHA-256 of the canonical snapshot: keys sorted, empty values dropped, the unit id and seat-local fields
- * removed (revision counter, collab stamps, layout state, selections), adjacent equal text runs merged, split
- * pieces of one custom range or decoration folded, and `paragraphId` dropped (Univer's TextX.apply mints a
- * random one per seat, C0 surprise 3). Header, footer and note bodies get the same rules.
- *
- * Two seats with equal content hash equal; one character more hashes differently. Browser and Node: the
- * digest is Web Crypto's.
- */
 /** Never content: the collab stamps, revision counters, seat-local view state. */
 declare const DOC_LOCAL_KEYS: string[];
+/**
+ * The snapshot as a seat holds it after loading it: what `DocumentModel` / the editor mount do (deterministic
+ * ids, `sanitizeUniverDocSnapshot`), then Univer's own model normalisation (`createDocumentSnapshot` inside
+ * `DocumentDataModel`). Idempotent: a snapshot a seat saved comes back unchanged in content.
+ */
+declare function asLoadedDocsSnapshot(snapshot: unknown): Record<string, unknown>;
 /** The canonical Docs snapshot: content only, keys sorted, runs normalized, local fields removed. */
 declare function canonicalDocsSnapshot(snapshot: unknown): unknown;
 /** The canonical form as the string the hash digests (tests compare these directly). */
@@ -856,4 +851,4 @@ declare function startWorkbookOtRoom(port: SheetsOtPort & {
     dispose?: () => void;
 }, o: WorkbookOtRoomOptions): Promise<WorkbookOtRoomHandle>;
 
-export { COLLAB_COVERED_KEY, type CollabBase, type CollabMutationInfo, type CollabProviderLike, type CommandServiceLike, DOCS_COLLAB_PROTO, DOCS_TRANSFORM_VERSION, DOC_LOCAL_KEYS, type DocsLocalMutation, type DocsLost, type DocsOp, type DocsOtNotice, type DocsOtPort, type DocsOtRoom, type DocsTransformResult, type DocumentOtFactoryOptions, type DocumentRestoreDeps, type DocumentRestoreResult, type OpenDocsOtRoomOptions, type OpenSheetsOtRoomOptions, type OtRoomsKnob, RICH_TEXT_EDITING, SENDER_VIEW_PARAMS, SHEETS_COLLAB_PROTO, SHEETS_EDIT_GROUP, type SheetOp, type SheetSelection, type SheetsCommandService, type SheetsLocalEvent, type SheetsLocalGroup, type SheetsNotShared, type SheetsOtAdapter, type SheetsOtAdapterHooks, type SheetsOtNotice, type SheetsOtPort, type SheetsOtRoom, type SheetsWorkbookLike, type SheetsWorksheetLike, type UniverSheetsOtPortOptions, WorkbookCollabSession, type WorkbookCollabSessionOptions, type WorkbookOtRoomHandle, type WorkbookOtRoomOptions, type WorkbookOtRoomsKnob, applyDocsOp, canonicalDocsSnapshot, canonicalDocsString, canonicalKeys, canonicalSheet, canonicalSheetString, composeDocsOps, createSheetsOtAdapter, decodeSheetOp, docsStateHash, documentOtFactory, documentUsesOrderedRoom, dropEmptyStyleRetains, encodeSheetOp, invertDocsOp, isCellEditorScratch, isNoopDocsOp, moveSelectionsThrough, normalizeDocsOp, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };
+export { COLLAB_COVERED_KEY, type CollabBase, type CollabMutationInfo, type CollabProviderLike, type CommandServiceLike, DOCS_COLLAB_PROTO, DOCS_TRANSFORM_VERSION, DOC_LOCAL_KEYS, type DocsLocalMutation, type DocsLost, type DocsOp, type DocsOtNotice, type DocsOtPort, type DocsOtRoom, type DocsTransformResult, type DocumentOtFactoryOptions, type DocumentRestoreDeps, type DocumentRestoreResult, type OpenDocsOtRoomOptions, type OpenSheetsOtRoomOptions, type OtRoomsKnob, RICH_TEXT_EDITING, SENDER_VIEW_PARAMS, SHEETS_COLLAB_PROTO, SHEETS_EDIT_GROUP, type SheetOp, type SheetSelection, type SheetsCommandService, type SheetsLocalEvent, type SheetsLocalGroup, type SheetsNotShared, type SheetsOtAdapter, type SheetsOtAdapterHooks, type SheetsOtNotice, type SheetsOtPort, type SheetsOtRoom, type SheetsWorkbookLike, type SheetsWorksheetLike, type UniverSheetsOtPortOptions, WorkbookCollabSession, type WorkbookCollabSessionOptions, type WorkbookOtRoomHandle, type WorkbookOtRoomOptions, type WorkbookOtRoomsKnob, applyDocsOp, asLoadedDocsSnapshot, canonicalDocsSnapshot, canonicalDocsString, canonicalKeys, canonicalSheet, canonicalSheetString, composeDocsOps, createSheetsOtAdapter, decodeSheetOp, docsStateHash, documentOtFactory, documentUsesOrderedRoom, dropEmptyStyleRetains, encodeSheetOp, invertDocsOp, isCellEditorScratch, isNoopDocsOp, moveSelectionsThrough, normalizeDocsOp, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };

package/dist/univer-collab.js

@@ -870,6 +870,104 @@ function invertDocsOp(op, preDoc) {
 }
 var DOCS_TRANSFORM_VERSION = "univer-1.0.4+docs-ot-r6";
 
+// src/univer/collab/docs-ot/state-hash.ts
+import { DocumentDataModel } from "@univerjs/core";
+
+// src/docs/sanitize-univer-doc-snapshot.ts
+import { NamedStyleType } from "@univerjs/core";
+
+// src/core/document-page-style.ts
+var TRADITIONAL = 1;
+var PORTRAIT = 0;
+var PX_PER_INCH = 96;
+var DEFAULT_DOCUMENT_PAGE_STYLE = {
+  pageSize: { width: 816, height: 1056 },
+  documentFlavor: TRADITIONAL,
+  pageOrient: PORTRAIT,
+  marginTop: PX_PER_INCH,
+  marginBottom: PX_PER_INCH,
+  marginLeft: PX_PER_INCH,
+  marginRight: PX_PER_INCH,
+  // Univer applies no paragraph spacing to a paginated page by itself; without this every paragraph
+  // runs into the next (Google Docs' own default: 1.15 lines, 10px after).
+  defaultParagraphStyle: { spaceAbove: { v: 0 }, spaceBelow: { v: 10 }, lineSpacing: 1.15 }
+};
+function defaultDocumentPageStyle() {
+  return {
+    ...DEFAULT_DOCUMENT_PAGE_STYLE,
+    pageSize: { ...DEFAULT_DOCUMENT_PAGE_STYLE.pageSize },
+    defaultParagraphStyle: { ...DEFAULT_DOCUMENT_PAGE_STYLE.defaultParagraphStyle }
+  };
+}
+function isLegacySqueezedPageStyle(style) {
+  const size = style?.pageSize;
+  return !!size && size.width === 595 && size.height === 842 && style?.marginLeft === 90 && style?.marginRight === 90 && style?.marginTop === 72 && style?.marginBottom === 72;
+}
+var PAGE_COLORS = ["#ffffff", "#fff8e7", "#f3f3f3", "#e8f0fe", "#e6f4ea", "#fef7e0"];
+var DEFAULT_PAGE_COLOR = PAGE_COLORS[0];
+
+// src/docs/sanitize-univer-doc-snapshot.ts
+var NAMED_STYLE_STRING_TO_NUMBER = Object.fromEntries(
+  Object.entries(NamedStyleType).filter(([key, val]) => typeof val === "number" && isNaN(Number(key))).map(([key, val]) => [key, val])
+);
+function sanitizeUniverDocSnapshot(snapshot, docId, opts = {}) {
+  restorePageStyle(snapshot, docId, opts.quiet === true);
+  ensureTextRuns(snapshot);
+  const paragraphs = snapshot?.body?.paragraphs;
+  if (!Array.isArray(paragraphs)) return snapshot;
+  let fixed = 0;
+  for (const paragraph of paragraphs) {
+    const style = paragraph?.paragraphStyle;
+    const value = style?.namedStyleType;
+    if (typeof value === "string") {
+      const numeric = NAMED_STYLE_STRING_TO_NUMBER[value];
+      if (numeric !== void 0) {
+        style.namedStyleType = numeric;
+        fixed += 1;
+      } else {
+        delete style.namedStyleType;
+        fixed += 1;
+      }
+    }
+  }
+  if (fixed > 0 && opts.quiet !== true) {
+    console.warn(
+      `[data-tables] RECOVERY: sanitized ${fixed} string namedStyleType value(s) to numeric NamedStyleType in document snapshot${docId ? ` ${docId}` : ""}. The snapshot was written with the wrong enum encoding (string instead of number) and would have crashed Univer's <ParagraphMenu>. Fix the snapshot writer to emit numeric NamedStyleType values.`
+    );
+  }
+  return snapshot;
+}
+function restorePageStyle(snapshot, docId, quiet = false) {
+  if (!snapshot || typeof snapshot !== "object") return;
+  const style = snapshot.documentStyle;
+  if (style?.pageSize?.width && isLegacySqueezedPageStyle(style)) {
+    const page = defaultDocumentPageStyle();
+    snapshot.documentStyle = { ...style, ...page, defaultParagraphStyle: style.defaultParagraphStyle ?? page.defaultParagraphStyle };
+    return;
+  }
+  if (style?.pageSize?.width) {
+    if (!style.documentFlavor) {
+      const page = defaultDocumentPageStyle();
+      Object.assign(style, { documentFlavor: page.documentFlavor });
+      if (page.defaultParagraphStyle) style.defaultParagraphStyle ??= page.defaultParagraphStyle;
+    }
+    return;
+  }
+  snapshot.documentStyle = {
+    ...defaultDocumentPageStyle(),
+    ...snapshot.documentStyle ?? {},
+    pageSize: defaultDocumentPageStyle().pageSize
+  };
+  if (quiet) return;
+  console.warn(
+    `[data-tables] RECOVERY: document snapshot${docId ? ` ${docId}` : ""} had no documentStyle.pageSize \u2014 restored the default Letter page geometry. Without a page box Univer lays the body out unbounded: text does not wrap and the viewport has no scrollable extent, so the document appears frozen. Fix the snapshot writer (agent/markdown converters must stamp DEFAULT_DOCUMENT_PAGE_STYLE).`
+  );
+}
+function ensureTextRuns(snapshot) {
+  const body = snapshot?.body;
+  if (body && typeof body === "object" && !Array.isArray(body.textRuns)) body.textRuns = [];
+}
+
 // src/univer/collab/docs-ot/state-hash.ts
 var DOC_LOCAL_KEYS = ["rev", "__matrxCollabCovered", "__collab", "disabled", "layoutState", "textRanges", "selections"];
 function sortDeep(v) {
@@ -929,6 +1027,7 @@ function canonicalBody(body) {
   const b = { ...body };
   b.textRuns = canonicalRuns(b.textRuns);
   if (Array.isArray(b.paragraphs)) b.paragraphs = b.paragraphs.map(({ paragraphId: _p, ...p }) => p);
+  if (Array.isArray(b.sectionBreaks)) b.sectionBreaks = b.sectionBreaks.map(({ sectionId: _s, ...x }) => x);
   b.customRanges = foldPieces(b.customRanges, (r) => JSON.stringify([rootId(r.rangeId), r.rangeType, sortDeep(r.properties ?? {})])).map((r) => ({
     ...r,
     rangeId: rootId(r.rangeId)
@@ -943,8 +1042,20 @@ function canonicalBody(body) {
   }
   return b;
 }
+function asLoadedDocsSnapshot(snapshot) {
+  const s = stampDeterministicIds(structuredClone(snapshot ?? {}));
+  delete s.id;
+  for (const k of DOC_LOCAL_KEYS) delete s[k];
+  sanitizeUniverDocSnapshot(s, void 0, { quiet: true });
+  const model = new DocumentDataModel(s);
+  try {
+    return structuredClone(model.getSnapshot());
+  } finally {
+    model.dispose();
+  }
+}
 function canonicalDocsSnapshot(snapshot) {
-  const s = structuredClone(snapshot ?? {});
+  const s = asLoadedDocsSnapshot(snapshot);
   delete s.id;
   for (const k of DOC_LOCAL_KEYS) delete s[k];
   s.body = canonicalBody(s.body);
@@ -1153,7 +1264,10 @@ function openDocsOtRoom(o) {
       queue = next.filter((q) => !isNoopDocsOp(q));
       if (isNoopDocsOp(op)) return;
     }
-    if (!session.local(op, { ...inverse !== void 0 ? { inverse } : {}, label: m.cmd ?? RICH_TEXT_EDITING })) notice({ kind: "not_live" });
+    if (!session.local(op, { ...inverse !== void 0 ? { inverse } : {}, label: m.cmd ?? RICH_TEXT_EDITING })) {
+      notice({ kind: "not_live" });
+      session.rebuild("not_live");
+    }
   };
   const unsubLocal = port.onLocal(onLocal);
   const target = o.compositionTarget === void 0 ? typeof document !== "undefined" ? document : null : o.compositionTarget;
@@ -1214,6 +1328,7 @@ import * as Y2 from "yjs";
 import { Awareness as Awareness2 } from "y-protocols/awareness";
 import {
   awarenessOpPresence,
+  claimCollaboratorColor,
   collabReplace,
   collabRoomExists,
   SupabaseYjsProvider,
@@ -1378,15 +1493,6 @@ async function documentUsesOrderedRoom(documentId, knob, isNewDocument) {
   if (knob === "new") return isNewDocument();
   return false;
 }
-function pickColor2(uid) {
-  const palette = ["#ef4444", "#f59e0b", "#10b981", "#3b82f6", "#8b5cf6", "#ec4899", "#14b8a6", "#f97316"];
-  let h = 2166136261;
-  for (let i = 0; i < uid.length; i++) {
-    h ^= uid.charCodeAt(i);
-    h = Math.imul(h, 16777619);
-  }
-  return palette[Math.abs(h) % palette.length] ?? "#ec4899";
-}
 function documentOtFactory(o) {
   return async (basePort, onAwareness) => {
     const latest = await getLatestDocumentSnapshot(o.documentId);
@@ -1400,7 +1506,8 @@ function documentOtFactory(o) {
     }
     const doc = new Y2.Doc();
     const awareness = new Awareness2(doc);
-    awareness.setLocalState({ uid: o.uid, clientId: o.clientId, name: o.displayName ?? o.uid.slice(0, 8), color: pickColor2(o.uid), ts: Date.now() });
+    awareness.setLocalState({ uid: o.uid, clientId: o.clientId, name: o.displayName ?? o.uid.slice(0, 8), ts: Date.now() });
+    const stopColor = claimCollaboratorColor(awareness, { uid: o.uid, clientId: o.clientId });
     const carets = new RemoteCaretBook(awareness.clientID);
     const emit = () => onAwareness({ states: new Map(awareness.getStates()), selfUid: o.uid, carets: carets.list() });
     const publishAwareness = () => {
@@ -1486,6 +1593,7 @@ function documentOtFactory(o) {
       replace: (snapshot) => room.replace(snapshot),
       stop: () => {
         clearInterval(caretTimer);
+        stopColor();
         room.stop();
         awareness.off("change", publishAwareness);
         provider.disconnect();
@@ -3274,7 +3382,7 @@ function univerSheetsOtPort(o) {
       const a = forApply(m);
       applying = true;
       try {
-        const ok2 = cs.syncExecuteCommand(a.id, { ...json(a.params), unitId: u }, { onlyLocal: true, fromCollab: true });
+        const ok2 = cs.syncExecuteCommand(a.id, { ...json(a.params), unitId: u }, { fromCollab: true });
         if (ok2 === false) throw new Error(`"${m.id}" was refused by the editor`);
       } finally {
         applying = false;
@@ -3454,7 +3562,7 @@ async function workbookUsesOrderedRoom(workbookId, knob, isNewWorkbook) {
   if (knob === "new") return isNewWorkbook();
   return false;
 }
-function pickColor3(uid) {
+function pickColor2(uid) {
   const palette = ["#ef4444", "#f59e0b", "#10b981", "#3b82f6", "#8b5cf6", "#ec4899", "#14b8a6", "#f97316"];
   let h = 2166136261;
   for (let i = 0; i < uid.length; i++) {
@@ -3479,7 +3587,7 @@ async function startWorkbookOtRoom(port, o) {
     uid: o.uid,
     clientId: o.clientId,
     name: o.displayName ?? o.uid.slice(0, 8),
-    color: pickColor3(o.uid),
+    color: pickColor2(o.uid),
     sheetId: null,
     row: null,
     col: null,
@@ -3550,6 +3658,7 @@ export {
   SHEETS_EDIT_GROUP,
   WorkbookCollabSession,
   applyDocsOp,
+  asLoadedDocsSnapshot,
   canonicalDocsSnapshot,
   canonicalDocsString,
   canonicalKeys,