@ai-matrx/office 0.8.22 → 0.8.24

package/dist/univer-collab.d.cts

@@ -1,6 +1,6 @@
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
-import { OpSessionNotice, OpSession, OpTransport, OpPresence, OpSessionIncident, OpSessionStatus, AwarenessState, CollabRpcClient, collabReplace, OpDocumentAdapter } from '@ai-matrx/data/realtime/collab';
+import { OpSessionNotice, OpSession, OpTransport, OpPresence, OpSessionIncident, OpSessionStatus, OpOfflineOptions, OpOfflineState, AwarenessState, CollabRpcClient, collabReplace, OpDocumentAdapter, CollabGroup } from '@ai-matrx/data/realtime/collab';
 import { IDocumentData } from '@univerjs/core';
 import { CommitReason } from '@ai-matrx/kit/working-copy';
 
@@ -362,6 +362,10 @@ interface OpenDocsOtRoomOptions {
     onNotice?: (n: DocsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: unsent edits persist on this device under a lease (the host builds it: `browserOfflineOptions`). */
+    offline?: OpOfflineOptions | null;
+    /** C10: the chrome's offline state. */
+    onOffline?: (s: OpOfflineState) => void;
     /** Watch IME composition here (default: `document`). */
     compositionTarget?: Pick<Document, "addEventListener" | "removeEventListener"> | null;
 }
@@ -481,6 +485,8 @@ interface DocumentOtFactoryOptions {
     onNotice?: (n: DocsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: the chrome's offline state (unsent edits are kept on this device, one tab per document and person owns them). */
+    onOffline?: (s: OpOfflineState) => void;
 }
 /** The `DocumentModel.startOtRoom` factory for one document. */
 declare function documentOtFactory(o: DocumentOtFactoryOptions): DocumentOtFactory;
@@ -683,6 +689,10 @@ interface OpenSheetsOtRoomOptions {
     onNotice?: (n: SheetsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: unsent edits persist on this device under a lease (the host builds it: `browserOfflineOptions`). */
+    offline?: OpOfflineOptions | null;
+    /** C10: the chrome's offline state. */
+    onOffline?: (s: OpOfflineState) => void;
 }
 interface SheetsOtRoom {
     session: OpSession<SheetOp>;
@@ -821,6 +831,15 @@ declare const canonicalSheetString: (snapshot: unknown) => string;
 /** SHA-256 (hex) of the canonical form. Web Crypto, so the browser and Node compute the same hash. */
 declare function sheetsStateHash(snapshot: unknown): Promise<string>;
 
+/**
+ * "Copy my offline text" (C10): the words a person typed while offline, pulled out of the wire groups of a buffer
+ * the room refused (changed protocol, document trashed). Format-light on purpose: Docs inserts carry their text in
+ * `body.dataStream`; Sheets writes carry cell values in `cellValue`. Anything else contributes nothing, and the
+ * caller says so when nothing could be read (the record stays on the device regardless).
+ */
+
+declare function offlineTextOfGroups(buffers: CollabGroup[][]): string;
+
 /** `collab.ot_rooms` (§12.2): which workbooks without a room open one. */
 type WorkbookOtRoomsKnob = "off" | "new" | "all";
 /** Whether this workbook opens on the ordered log: its room exists, or the knob opens one. */
@@ -836,6 +855,8 @@ interface WorkbookOtRoomOptions {
     onNotice?: (n: SheetsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: the chrome's offline state (unsent edits are kept on this device, one tab per workbook and person owns them). */
+    onOffline?: (s: OpOfflineState) => void;
 }
 interface WorkbookOtRoomHandle {
     session: OpSession<SheetOp>;
@@ -857,4 +878,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, 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 };
+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, offlineTextOfGroups, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };

package/dist/univer-collab.d.ts

@@ -1,6 +1,6 @@
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
-import { OpSessionNotice, OpSession, OpTransport, OpPresence, OpSessionIncident, OpSessionStatus, AwarenessState, CollabRpcClient, collabReplace, OpDocumentAdapter } from '@ai-matrx/data/realtime/collab';
+import { OpSessionNotice, OpSession, OpTransport, OpPresence, OpSessionIncident, OpSessionStatus, OpOfflineOptions, OpOfflineState, AwarenessState, CollabRpcClient, collabReplace, OpDocumentAdapter, CollabGroup } from '@ai-matrx/data/realtime/collab';
 import { IDocumentData } from '@univerjs/core';
 import { CommitReason } from '@ai-matrx/kit/working-copy';
 
@@ -362,6 +362,10 @@ interface OpenDocsOtRoomOptions {
     onNotice?: (n: DocsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: unsent edits persist on this device under a lease (the host builds it: `browserOfflineOptions`). */
+    offline?: OpOfflineOptions | null;
+    /** C10: the chrome's offline state. */
+    onOffline?: (s: OpOfflineState) => void;
     /** Watch IME composition here (default: `document`). */
     compositionTarget?: Pick<Document, "addEventListener" | "removeEventListener"> | null;
 }
@@ -481,6 +485,8 @@ interface DocumentOtFactoryOptions {
     onNotice?: (n: DocsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: the chrome's offline state (unsent edits are kept on this device, one tab per document and person owns them). */
+    onOffline?: (s: OpOfflineState) => void;
 }
 /** The `DocumentModel.startOtRoom` factory for one document. */
 declare function documentOtFactory(o: DocumentOtFactoryOptions): DocumentOtFactory;
@@ -683,6 +689,10 @@ interface OpenSheetsOtRoomOptions {
     onNotice?: (n: SheetsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: unsent edits persist on this device under a lease (the host builds it: `browserOfflineOptions`). */
+    offline?: OpOfflineOptions | null;
+    /** C10: the chrome's offline state. */
+    onOffline?: (s: OpOfflineState) => void;
 }
 interface SheetsOtRoom {
     session: OpSession<SheetOp>;
@@ -821,6 +831,15 @@ declare const canonicalSheetString: (snapshot: unknown) => string;
 /** SHA-256 (hex) of the canonical form. Web Crypto, so the browser and Node compute the same hash. */
 declare function sheetsStateHash(snapshot: unknown): Promise<string>;
 
+/**
+ * "Copy my offline text" (C10): the words a person typed while offline, pulled out of the wire groups of a buffer
+ * the room refused (changed protocol, document trashed). Format-light on purpose: Docs inserts carry their text in
+ * `body.dataStream`; Sheets writes carry cell values in `cellValue`. Anything else contributes nothing, and the
+ * caller says so when nothing could be read (the record stays on the device regardless).
+ */
+
+declare function offlineTextOfGroups(buffers: CollabGroup[][]): string;
+
 /** `collab.ot_rooms` (§12.2): which workbooks without a room open one. */
 type WorkbookOtRoomsKnob = "off" | "new" | "all";
 /** Whether this workbook opens on the ordered log: its room exists, or the knob opens one. */
@@ -836,6 +855,8 @@ interface WorkbookOtRoomOptions {
     onNotice?: (n: SheetsOtNotice) => void;
     onIncident?: (i: OpSessionIncident) => void;
     onStatus?: (s: OpSessionStatus) => void;
+    /** C10: the chrome's offline state (unsent edits are kept on this device, one tab per workbook and person owns them). */
+    onOffline?: (s: OpOfflineState) => void;
 }
 interface WorkbookOtRoomHandle {
     session: OpSession<SheetOp>;
@@ -857,4 +878,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, 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 };
+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, offlineTextOfGroups, openDocsOtRoom, openSheetsOtRoom, rebaseSheetUndoStack, rebaseUndoStack, restoreDocumentSnapshot, sheetsStateHash, stampCovered, stampDeterministicIds, startWorkbookOtRoom, stripSenderView, takeCovered, transformDocsOp, transformSheetOp, transformTextX, undoStacksOf, univerSheetsOtPort, workbookUsesOrderedRoom };