@ai-matrx/office 0.8.16 → 0.8.17

package/dist/univer-collab.d.cts

@@ -736,6 +736,8 @@ interface SheetsCommandService {
 interface SheetsWorksheetLike {
     getSheetId(): string;
     getName(): string;
+    getMaxRows?(): number;
+    getMaxColumns?(): number;
     getCellRaw(row: number, col: number): Obj | null | undefined;
     getMergeData(): SheetRange[];
 }
@@ -760,13 +762,44 @@ interface UniverSheetsOtPortOptions {
     saveUnit?(unitId: string): unknown | null;
     /** Univer's undo/redo service. */
     undoRedo?(): unknown | null;
+    /**
+     * This seat's selections on the active sheet (`SheetsSelectionsService`). A remote row/column insert, remove or
+     * move carries this seat's selection with it, and a selection a remote remove took away is clamped to the
+     * sheet: a selection left past the sheet's edge breaks every reader of the active range.
+     */
+    selections?: {
+        sheetId(): string | null;
+        get(): SheetSelection[] | null | undefined;
+        set(selections: SheetSelection[]): void;
+    };
     /** Replace the workbook's whole content, keeping its unit id. */
     load(snapshot: unknown): void;
     markDirty(): void;
 }
+/** One selection as `SheetsSelectionsService` holds it (range, primary cell, style). */
+interface SheetSelection {
+    range: SheetRange & {
+        rangeType?: number;
+    };
+    primary?: (Record<string, unknown> & {
+        startRow?: number;
+        endRow?: number;
+        startColumn?: number;
+        endColumn?: number;
+        actualRow?: number;
+        actualColumn?: number;
+    }) | null;
+    style?: unknown;
+}
 declare function univerSheetsOtPort(o: UniverSheetsOtPortOptions): SheetsOtPort & {
     dispose(): void;
+    running(): string[];
 };
+/**
+ * This seat's selections after a remote structural op: indices move with their rows/columns; one the op removed
+ * lands on the first surviving index; everything is clamped to the sheet; whole-row/column ranges span the sheet.
+ */
+declare function moveSelectionsThrough(selections: SheetSelection[], m: SheetMutation, maxRows: number, maxCols: number): SheetSelection[];
 
 /**
  * The canonical Sheets state hash (COLLAB-DESIGN §7.2, C0 item 6, §21.3): two seats holding the same workbook
@@ -823,4 +856,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 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, 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, 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

@@ -736,6 +736,8 @@ interface SheetsCommandService {
 interface SheetsWorksheetLike {
     getSheetId(): string;
     getName(): string;
+    getMaxRows?(): number;
+    getMaxColumns?(): number;
     getCellRaw(row: number, col: number): Obj | null | undefined;
     getMergeData(): SheetRange[];
 }
@@ -760,13 +762,44 @@ interface UniverSheetsOtPortOptions {
     saveUnit?(unitId: string): unknown | null;
     /** Univer's undo/redo service. */
     undoRedo?(): unknown | null;
+    /**
+     * This seat's selections on the active sheet (`SheetsSelectionsService`). A remote row/column insert, remove or
+     * move carries this seat's selection with it, and a selection a remote remove took away is clamped to the
+     * sheet: a selection left past the sheet's edge breaks every reader of the active range.
+     */
+    selections?: {
+        sheetId(): string | null;
+        get(): SheetSelection[] | null | undefined;
+        set(selections: SheetSelection[]): void;
+    };
     /** Replace the workbook's whole content, keeping its unit id. */
     load(snapshot: unknown): void;
     markDirty(): void;
 }
+/** One selection as `SheetsSelectionsService` holds it (range, primary cell, style). */
+interface SheetSelection {
+    range: SheetRange & {
+        rangeType?: number;
+    };
+    primary?: (Record<string, unknown> & {
+        startRow?: number;
+        endRow?: number;
+        startColumn?: number;
+        endColumn?: number;
+        actualRow?: number;
+        actualColumn?: number;
+    }) | null;
+    style?: unknown;
+}
 declare function univerSheetsOtPort(o: UniverSheetsOtPortOptions): SheetsOtPort & {
     dispose(): void;
+    running(): string[];
 };
+/**
+ * This seat's selections after a remote structural op: indices move with their rows/columns; one the op removed
+ * lands on the first surviving index; everything is clamped to the sheet; whole-row/column ranges span the sheet.
+ */
+declare function moveSelectionsThrough(selections: SheetSelection[], m: SheetMutation, maxRows: number, maxCols: number): SheetSelection[];
 
 /**
  * The canonical Sheets state hash (COLLAB-DESIGN §7.2, C0 item 6, §21.3): two seats holding the same workbook
@@ -823,4 +856,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 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, 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, 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

@@ -3240,12 +3240,30 @@ function univerSheetsOtPort(o) {
     }
     if (lone && tracker.stack.length === 0) settle();
   });
+  const followSelection = (m) => {
+    const sel = o.selections;
+    if (!sel || !axisOpOf(m)) return;
+    try {
+      const sheet = String(m.params.subUnitId ?? "");
+      if (sel.sheetId() !== sheet) return;
+      const ws = o.workbook()?.getSheetBySheetId(sheet);
+      const current = sel.get();
+      if (!ws || !current?.length) return;
+      const rows = ws.getMaxRows?.() ?? Number.MAX_SAFE_INTEGER;
+      const cols = ws.getMaxColumns?.() ?? Number.MAX_SAFE_INTEGER;
+      sel.set(moveSelectionsThrough(json(current), m, rows, cols));
+    } catch (err) {
+      console.warn("[sheets-ot] could not move this seat's selection past a collaborator's row or column change", err);
+    }
+  };
   return {
     onLocal(listener) {
       listeners.add(listener);
       return () => void listeners.delete(listener);
     },
     busy: () => tracker.stack.length > 0 || group !== null,
+    /** The outermost commands still running here (why the port is busy), for logs. */
+    running: () => [...tracker.stack, ...group && tracker.stack.length === 0 ? ["(group)"] : []],
     whenIdle(fn) {
       if (tracker.stack.length === 0 && !group) fn();
       else idle.push(fn);
@@ -3261,6 +3279,7 @@ function univerSheetsOtPort(o) {
       } finally {
         applying = false;
       }
+      followSelection(m);
     },
     snapshot() {
       const wb = o.workbook();
@@ -3298,6 +3317,68 @@ function fullContent(cell) {
   if (out.v === null) delete out.t;
   return out;
 }
+function axisOpOf(m) {
+  const p = m.params;
+  const span = (r, axis) => axis === "row" ? [r.startRow, r.endRow - r.startRow + 1] : [r.startColumn, r.endColumn - r.startColumn + 1];
+  switch (m.id) {
+    case "sheet.mutation.insert-row": {
+      const [at, count] = span(p.range, "row");
+      return { axis: "row", op: { kind: "insert", at, count } };
+    }
+    case "sheet.mutation.insert-col": {
+      const [at, count] = span(p.range, "col");
+      return { axis: "col", op: { kind: "insert", at, count } };
+    }
+    case "sheet.mutation.remove-rows": {
+      const [start, count] = span(p.range, "row");
+      return { axis: "row", op: { kind: "remove", start, count } };
+    }
+    case "sheet.mutation.remove-col": {
+      const [start, count] = span(p.range, "col");
+      return { axis: "col", op: { kind: "remove", start, count } };
+    }
+    case "sheet.mutation.move-rows": {
+      const [from, count] = span(p.sourceRange, "row");
+      return { axis: "row", op: { kind: "move", from, count, to: p.targetRange.startRow } };
+    }
+    case "sheet.mutation.move-columns": {
+      const [from, count] = span(p.sourceRange, "col");
+      return { axis: "col", op: { kind: "move", from, count, to: p.targetRange.startColumn } };
+    }
+    default:
+      return null;
+  }
+}
+function moveSelectionsThrough(selections, m, maxRows, maxCols) {
+  const a = axisOpOf(m);
+  const clamp = (v, max) => Math.max(0, Math.min(v, Math.max(0, max - 1)));
+  const through = (i, axis) => {
+    if (typeof i !== "number") return i;
+    let next = i;
+    if (a && a.axis === axis) {
+      const mapped = mapIndex(a.op, i);
+      next = mapped ?? (a.op.kind === "remove" ? a.op.start : i);
+    }
+    return clamp(next, axis === "row" ? maxRows : maxCols);
+  };
+  const box = (r, rangeType) => {
+    const out = { ...r };
+    for (const k of ["startRow", "endRow", "actualRow"]) if (k in out) out[k] = through(out[k], "row");
+    for (const k of ["startColumn", "endColumn", "actualColumn"]) if (k in out) out[k] = through(out[k], "col");
+    if (typeof out.startRow === "number" && typeof out.endRow === "number" && out.endRow < out.startRow) out.endRow = out.startRow;
+    if (typeof out.startColumn === "number" && typeof out.endColumn === "number" && out.endColumn < out.startColumn) out.endColumn = out.startColumn;
+    if (rangeType === 1 || rangeType === 3) {
+      out.startColumn = 0;
+      out.endColumn = Math.max(0, maxCols - 1);
+    }
+    if (rangeType === 2 || rangeType === 3) {
+      out.startRow = 0;
+      out.endRow = Math.max(0, maxRows - 1);
+    }
+    return out;
+  };
+  return selections.map((s) => ({ ...s, range: box(s.range, s.range.rangeType), ...s.primary ? { primary: box(s.primary) } : {} }));
+}
 
 // src/sheets/workbook-ot-room.ts
 import * as Y3 from "yjs";
@@ -3485,6 +3566,7 @@ export {
   invertDocsOp,
   isCellEditorScratch,
   isNoopDocsOp,
+  moveSelectionsThrough,
   normalizeDocsOp,
   openDocsOtRoom,
   openSheetsOtRoom,