@fileverse-dev/dsheet 4.1.23-stabilise-package-5 → 4.1.23-stabilise-package-7

package/dist/editor/hooks/use-celldata-compaction.d.ts

@@ -3,6 +3,10 @@ import { WorkbookInstance, Sheet } from '../../sheet-engine/react';
 import { planYdocCompaction } from '../utils/compact-committed-celldata';
 
 import * as Y from 'yjs';
+/** Wait before a refused or stopped run is tried again. */
+export declare const COMPACTION_RETRY_MS = 30000;
+/** Tries after the first run; the compaction is also retried on a later open. */
+export declare const COMPACTION_MAX_RETRIES = 10;
 type UseCelldataCompactionArgs = {
     dsheetId: string;
     ydocRef: RefObject<Y.Doc | null>;
@@ -26,6 +30,23 @@ export declare function canRunCompaction(refs: {
     remoteUpdateRef: MutableRefObject<boolean>;
     structuralRemountPendingRef?: MutableRefObject<boolean>;
 }, collabSyncing: boolean): boolean;
+/**
+ * Runs `attempt` and, when it asks for a retry (the gate was closed, or a run
+ * stopped because the document changed), calls `retry` after `delayMs`, up to
+ * `maxRetries` times. Without it a refused run waited for the next open, so
+ * compaction made one chunk of progress per open (PR 466 N10).
+ */
+export declare function createCompactionRetrier({ attempt, retry, delayMs, maxRetries, setTimer, clearTimer, }: {
+    attempt: () => Promise<'done' | 'retry'>;
+    retry: () => void;
+    delayMs?: number;
+    maxRetries?: number;
+    setTimer?: (cb: () => void, ms: number) => ReturnType<typeof setTimeout>;
+    clearTimer?: (handle: ReturnType<typeof setTimeout>) => void;
+}): {
+    run(): Promise<void>;
+    cancel(): void;
+};
 /**
  * Applies the plan chunk by chunk, yielding between chunks. The plan was made
  * from the document as it was, and one change in it, the whole-value