@univerjs-pro/collaboration 0.7.0-nightly.202505221607 → 0.7.0-nightly.202505241606

package/lib/types/index.d.ts

@@ -7,10 +7,11 @@ 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 { ISnapshotServerService, SnapshotService } from './services/snapshot/snapshot.service';
+export { SnapshotSaveService } from './services/snapshot/snapshot-save.service';
 export { generateTempDocumentSnapshot, generateTemporarySnap, getSheetBlocksFromSnapshot, transformDocumentDataToSnapshot, transformSnapshotToDocumentData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot } from './services/snapshot/snapshot-transform';
 export { textDecoder, textEncoder } from './services/snapshot/snapshot-utils';
 export { type IMutationTransformAlgorithm, ITransformService, TransformService, } from './services/transform/transform.service';
 export { type IFailureTransformChangesetsResult, type IFailureTransformMutationResult, type IFailureTransformMutationsResult, type IFailureTransformMutationsWithChangesetResult, isTransformChangesetsFailure, isTransformChangesetsSuccess, isTransformMutationFailure, isTransformMutationsFailure, isTransformMutationsSuccess, isTransformMutationSuccess, isTransformMutationsWithChangesetFailure, isTransformMutationsWithChangesetSuccess, type ISuccessTransformChangesetsResult, type ISuccessTransformMutationResult, type ISuccessTransformMutationsResult, type ISuccessTransformMutationsWithChangesetResult, type ITransformChangesetsResult, type ITransformMutationResult, type ITransformMutationsResult, type ITransformMutationsWithChangesetResult, } from './services/transform/types';
-export { b64DecodeUnicode, b64EncodeUnicode, type ILogContext, mapDocumentTypeToUniverType } from './utils';
+export { b64DecodeUnicode, b64EncodeUnicode, type ILogContext, mapDocumentTypeToUniverType, uuidv4 } from './utils';
 export { type IRevertRevisionMutationParams, RevertRevisionMutation } from './command/revert-revision.mutation';
 export { CreateUnitMutation, type ICreateUnitMutationParams } from './command/create-unit.mutation';

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

@@ -0,0 +1,33 @@
+import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
+import { ISnapshot } from '@univerjs/protocol';
+import { ILogContext } from '../../utils';
+import { ISnapshotServerService, SnapshotService } from './snapshot.service';
+/**
+ * This service provides methods to save snapshots into the database.
+ *
+ * It should be considered as a missing part ot `SnapshotService`. Because
+ * we only need to save snapshot on the server side, so we separate it from
+ * `SnapshotService`.
+ *
+ * Though this service is implemented in `@univerjs-pro/collaboration`, it is not registered by the plugin.
+ */
+export declare class SnapshotSaveService {
+    private readonly _snapshotServerService;
+    private _snapshotService;
+    constructor(_snapshotServerService: ISnapshotServerService, _snapshotService: SnapshotService);
+    saveSheet(context: ILogContext, unitId: string, rev: number, workbook: Workbook, workbookData?: IWorkbookData): Promise<{
+        snapshot: ISnapshot;
+    }>;
+    updateSheet(context: ILogContext, unitId: string, rev: number, workbook: Workbook, workbookData?: IWorkbookData): Promise<{
+        snapshot: ISnapshot;
+    }>;
+    getSheet(context: ILogContext, unitID: string, rev: number, workbook: Workbook): Promise<{
+        snapshot: ISnapshot;
+    }>;
+    getDoc(context: ILogContext, unitId: string, rev: number, document: DocumentDataModel): Promise<{
+        snapshot: ISnapshot;
+    }>;
+    saveDoc(context: ILogContext, unitId: string, rev: number, document: DocumentDataModel, documentData?: IDocumentData): Promise<{
+        snapshot: ISnapshot;
+    }>;
+}

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

@@ -8,7 +8,7 @@ export declare function generateTempDocumentSnapshot(_context: ILogContext, docu
 export declare function generateTemporarySnap(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
     snapshot: ISnapshot;
 }>;
-export declare function transformWorkbookDataToSnapshot(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+export declare function transformWorkbookDataToSnapshot(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService, performUpdate?: true): Promise<{
     snapshot: ISnapshot;
 }>;
 /**

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

@@ -1,4 +1,4 @@
-import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ICommandService, Injector, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
+import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ICommandService, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
 import { ICopyFileMetaRequest, ICopyFileMetaResponse, IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetDeserializedSheetBlockResponse, IGetLatestCsReqIdBySidRequest, IGetLatestCsReqIdBySidResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse } from '@univerjs/protocol';
 import { ILogContext } from '../../utils';
 import { CompressMutationService } from '../compress-mutation/compress-mutation-service';
@@ -20,6 +20,8 @@ export interface ISnapshotServerService {
     getResourcesRequest: (context: ILogContext, params: IGetResourcesRequest) => Promise<IGetResourcesResponse>;
     /** Save snapshot to a database. */
     saveSnapshot: (context: ILogContext, params: ISaveSnapshotRequest) => Promise<ISaveSnapshotResponse>;
+    /** update snapshot to the database. */
+    updateSnapshot: (context: ILogContext, params: ISaveSnapshotRequest) => Promise<ISaveSnapshotResponse>;
     /** Save sheet block to a database. */
     saveSheetBlock: (context: ILogContext, params: ISaveSheetBlockRequest) => Promise<ISaveSheetBlockResponse>;
     /** Save changeset to a database. */
@@ -35,18 +37,11 @@ export declare class SnapshotService {
     private readonly _univerInstanceService;
     private readonly _snapshotServerService;
     private readonly _commandService;
-    private _injector;
     private _compressMutationService;
     private _resourceManagerService;
-    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _injector: Injector, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
+    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
     loadSheet(unitId: string, rev: number, context?: ILogContext): Promise<Workbook>;
     loadDoc(unitID: string, rev: number, context?: ILogContext): Promise<DocumentDataModel>;
-    /**
-     * @deprecated This should be moved to `ResourceLoaderService.saveUnit`.
-     */
-    save(_context: ILogContext, workbook: Workbook): IWorkbookData;
-    /**
-     * @deprecated This should be moved to `ResourceLoaderService.saveUnit`.
-     */
+    saveSheet(_context: ILogContext, workbook: Workbook): IWorkbookData;
     saveDoc(_context: ILogContext, document: DocumentDataModel): IDocumentData;
 }

package/lib/types/utils.d.ts

@@ -19,3 +19,4 @@ export declare function b64EncodeUnicode(str: string): string;
  * @returns
  */
 export declare function b64DecodeUnicode(str: string): string;
+export { v4 as uuidv4 } from 'uuid';