@univerjs-pro/collaboration 1.0.0-alpha.3 → 1.0.0-alpha.4

package/lib/types/index.d.ts

@@ -16,6 +16,8 @@ export type { ICombRequestEvent, ICombResponseEvent, IHeartbeatRequestEvent, IHe
 export { UniverCollaborationPlugin } from './plugin';
 export { CompressMutationService } from './services/compress-mutation/compress-mutation.service';
 export { RevisionService, SINGLE_HISTORY_MUTATIONS, SINGLE_SNAPSHOT_MUTATIONS, } from './services/rev/rev.service';
+export { SNAPSHOT_LOADING_PREVIEW_BLOCK_LIMIT, SnapshotLoadingService, SnapshotLoadStage, } from './services/snapshot/snapshot-loading.service';
+export type { ISnapshotLoadState } from './services/snapshot/snapshot-loading.service';
 export { SnapshotSaveService } from './services/snapshot/snapshot-save.service';
 export { getSheetBlocksFromSnapshot, transformDocumentDataToSnapshot, transformSlideDataToSnapshot, transformSnapshotToDocumentData, transformSnapshotToSlideData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot, } from './services/snapshot/snapshot-transform';
 export { textDecoder, textEncoder, } from './services/snapshot/snapshot-utils';

package/lib/types/services/snapshot/snapshot-loading.service.d.ts

@@ -0,0 +1,37 @@
+import type { ICellData, IObjectMatrixPrimitiveType, IWorkbookData, UniverInstanceType } from '@univerjs/core';
+import { Disposable } from '@univerjs/core';
+export declare const SNAPSHOT_LOADING_PREVIEW_BLOCK_LIMIT = 3;
+export declare enum SnapshotLoadStage {
+    LOADING_SNAPSHOT = "loading-snapshot",
+    LOADING_BLOCKS = "loading-blocks",
+    COMPLETE = "complete",
+    ERROR = "error"
+}
+export interface ISnapshotLoadState {
+    unitId: string;
+    type: UniverInstanceType;
+    stage: SnapshotLoadStage;
+    totalBlocks: number;
+    loadedBlocks: number;
+    totalPreviewBlocks: number;
+    loadedPreviewBlocks: number;
+    previewReady: boolean;
+    activeSheetId?: string;
+    workbookShell?: IWorkbookData;
+    previewCellData?: IObjectMatrixPrimitiveType<ICellData>;
+    error?: Error;
+}
+/** Sheet snapshot loading state consumed by loading UI and preview renderers. */
+export declare class SnapshotLoadingService extends Disposable {
+    private readonly _stateByUnit;
+    private readonly _state$;
+    readonly state$: import("rxjs").Observable<ReadonlyMap<string, ISnapshotLoadState>>;
+    begin(unitId: string, type: UniverInstanceType): void;
+    setSnapshot(unitId: string, workbookShell: IWorkbookData, activeSheetId: string, totalBlocks: number, totalPreviewBlocks: number): void;
+    addBlock(unitId: string, subUnitId: string, cellData: IObjectMatrixPrimitiveType<ICellData>, isPreviewBlock?: boolean): void;
+    complete(unitId: string): void;
+    fail(unitId: string, error: Error): void;
+    getState(unitId: string): ISnapshotLoadState | undefined;
+    dispose(): void;
+    private _setState;
+}

package/lib/types/services/snapshot/snapshot-transform.d.ts

@@ -28,6 +28,10 @@ export declare function transformBaseDataToSnapshot(context: ILogContext, base:
  * @param sheetBlocks
  */
 export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: (IDeserializedSheetBlock | ISheetBlock)[], _context?: ILogContext, logService?: ILogService): Promise<IWorkbookData>;
+/**
+ * Builds the workbook shell from snapshot metadata without loading cell blocks.
+ */
+export declare function transformSnapshotToWorkbookDataWithoutBlocks(snapshot: ISnapshot): IWorkbookData;
 export declare function transformSnapshotToBaseData(snapshot: ISnapshot, baseBlocks?: (IDeserializedSheetBlock | ISheetBlock)[], _context?: ILogContext, logService?: ILogService): Promise<IBaseSnapshot>;
 export declare function transformSnapshotToDocumentData(snapshot: ISnapshot): IDocumentData;
 export declare function transformDocumentDataToSnapshot(context: ILogContext, document: IDocumentData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{

package/lib/types/services/snapshot/snapshot.service.d.ts

@@ -6,6 +6,7 @@ import type { ILogContext } from '../../utils';
 import { ICommandService, ILogService, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
 import { CompressMutationService } from '../compress-mutation/compress-mutation.service';
 import { RevisionService } from '../rev/rev.service';
+import { SnapshotLoadingService } from './snapshot-loading.service';
 export declare function hasSlideSnapshotMeta(snapshot: ISnapshot | null | undefined): boolean;
 export declare function hasBoardSnapshotMeta(snapshot: ISnapshot | null | undefined): boolean;
 /**
@@ -38,6 +39,7 @@ export interface ISnapshotServerService {
 }
 export interface ISnapshotLoadOptions {
     createOptions?: ICreateUnitOptions;
+    initialSubUnitId?: string;
 }
 /**
  * The service provides methods to load snapshots from the snapshot server.
@@ -50,12 +52,14 @@ export declare class SnapshotService {
     private readonly _logService;
     private _compressMutationService;
     private _resourceManagerService;
-    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _logService: ILogService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
+    private readonly _snapshotLoadingService;
+    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _logService: ILogService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService, _snapshotLoadingService: SnapshotLoadingService);
     loadSheet(unitId: string, rev: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<Workbook>;
+    private _getPrioritizedSheetBlocks;
     loadBase(unitId: string, rev: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<BaseDataModel>;
     loadDoc(unitID: string, rev: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<DocumentDataModel>;
     loadSlide(unitID: string, rev?: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<SlideModel>;
-    loadBoard(unitID: string, rev?: number, context?: ILogContext): Promise<BoardModel>;
+    loadBoard(unitID: string, rev?: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<BoardModel>;
     saveSheet(_context: ILogContext, workbook: Workbook): IWorkbookData;
     saveBase(_context: ILogContext, base: BaseDataModel): IBaseSnapshot;
     saveDoc(_context: ILogContext, document: DocumentDataModel): IDocumentData;