@univerjs-pro/collaboration 0.12.4 → 0.13.0

package/lib/types/controllers/sheet-transform/algorithms/set-worksheet-name/insert-worksheet.algo.d.ts

@@ -0,0 +1,3 @@
+import { IInsertSheetMutationParams, ISetWorksheetNameMutationParams } from '@univerjs/sheets';
+import { IMutationTransformAlgorithm } from '../../../../services/transform/transform.service';
+export declare const setWorksheetNameWithInsertSheet: IMutationTransformAlgorithm<ISetWorksheetNameMutationParams, IInsertSheetMutationParams>;

package/lib/types/index.d.ts

@@ -16,4 +16,4 @@ export { textDecoder, textEncoder } from './services/snapshot/snapshot-utils';
 export { ISnapshotServerService, SnapshotService } from './services/snapshot/snapshot.service';
 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, uuidv4 } from './utils';
+export { b64DecodeUnicode, b64EncodeUnicode, type ILogContext, mapDocumentTypeToUniverType, measureAsyncOperation, measureSyncOperation, uuidv4 } from './utils';

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

@@ -1,4 +1,4 @@
-import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
+import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ILogService } from '@univerjs/core';
 import { ISheetBlockMeta, ISnapshot } from '@univerjs/protocol';
 import { ILogContext } from '../../utils';
 import { ISnapshotServerService, SnapshotService } from './snapshot.service';
@@ -14,7 +14,8 @@ import { ISnapshotServerService, SnapshotService } from './snapshot.service';
 export declare class SnapshotSaveService {
     private readonly _snapshotServerService;
     private _snapshotService;
-    constructor(_snapshotServerService: ISnapshotServerService, _snapshotService: SnapshotService);
+    private readonly _logService;
+    constructor(_snapshotServerService: ISnapshotServerService, _snapshotService: SnapshotService, _logService: ILogService);
     saveSheet(context: ILogContext, unitId: string, rev: number, workbook: Workbook, workbookData?: IWorkbookData): Promise<{
         snapshot: ISnapshot;
     }>;

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

@@ -1,4 +1,4 @@
-import { IDocumentData, IWorkbookData } from '@univerjs/core';
+import { IDocumentData, ILogService, IWorkbookData } from '@univerjs/core';
 import { IDeserializedSheetBlock, ISheetBlock, ISheetBlockMeta, ISnapshot } from '@univerjs/protocol';
 import { ILogContext } from '../../utils';
 import { ISnapshotServerService } from './snapshot.service';
@@ -11,7 +11,7 @@ export declare function generateTemporarySnap(context: ILogContext, workbook: IW
 export declare function transformWorkbookDataToSnapshotNoSave(context: ILogContext, workbook: IWorkbookData, unitID: string, snapshotService: ISnapshotServerService): Promise<{
     [key: string]: ISheetBlockMeta;
 }>;
-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, logger?: ILogService): Promise<{
     snapshot: ISnapshot;
 }>;
 /**
@@ -19,7 +19,7 @@ export declare function transformWorkbookDataToSnapshot(context: ILogContext, wo
  * @param snapshot
  * @param sheetBlocks
  */
-export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: (IDeserializedSheetBlock | ISheetBlock)[], _context?: ILogContext): IWorkbookData;
+export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: (IDeserializedSheetBlock | ISheetBlock)[], _context?: ILogContext, logService?: ILogService): Promise<IWorkbookData>;
 export declare function transformSnapshotToDocumentData(snapshot: ISnapshot): IDocumentData;
 export declare function transformDocumentDataToSnapshot(context: ILogContext, document: IDocumentData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
     snapshot: ISnapshot;

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

@@ -1,4 +1,4 @@
-import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ICommandService, IResourceManagerService, IUniverInstanceService } from '@univerjs/core';
+import { DocumentDataModel, IDocumentData, IWorkbookData, Workbook, ICommandService, ILogService, 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';
@@ -14,7 +14,7 @@ export interface ISnapshotServerService {
     getUnitOnRev: (context: ILogContext, params: IGetUnitOnRevRequest) => Promise<IGetUnitOnRevResponse>;
     /** Load sheet block from a database. */
     getSheetBlock: (context: ILogContext, params: IGetSheetBlockRequest) => Promise<IGetSheetBlockResponse>;
-    getDeserializedSheetBlock: (context: ILogContext, params: IGetSheetBlockRequest) => Promise<IGetDeserializedSheetBlockResponse>;
+    getDeserializedSheetBlock: (context: ILogContext, params: IGetSheetBlockRequest) => Promise<IGetDeserializedSheetBlockResponse | IGetSheetBlockResponse>;
     /** Fetch missing changeset */
     fetchMissingChangesets: (context: ILogContext, params: IFetchMissingChangesetsRequest) => Promise<IFetchMissingChangesetsResponse>;
     getResourcesRequest: (context: ILogContext, params: IGetResourcesRequest) => Promise<IGetResourcesResponse>;
@@ -37,9 +37,10 @@ export declare class SnapshotService {
     private readonly _univerInstanceService;
     private readonly _snapshotServerService;
     private readonly _commandService;
+    private readonly _logService;
     private _compressMutationService;
     private _resourceManagerService;
-    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
+    constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _logService: ILogService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
     loadSheet(unitId: string, rev: number, context?: ILogContext): Promise<Workbook>;
     loadDoc(unitID: string, rev: number, context?: ILogContext): Promise<DocumentDataModel>;
     saveSheet(_context: ILogContext, workbook: Workbook): IWorkbookData;

package/lib/types/utils.d.ts

@@ -1,4 +1,4 @@
-import { UniverInstanceType } from '@univerjs/core';
+import { ILogService, UniverInstanceType } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
 export declare function mapDocumentTypeToUniverType(documentType: UniverInstanceType): UniverType;
 /**
@@ -20,3 +20,24 @@ export declare function b64EncodeUnicode(str: string): string;
  */
 export declare function b64DecodeUnicode(str: string): string;
 export { v4 as uuidv4 } from 'uuid';
+/**
+ * Limit the number of concurrent tasks to avoid OOM
+ */
+export declare function limitConcurrencyTasks<T>({ tasks, handleTaskResult, limit, options, onError, }: {
+    tasks: Array<() => Promise<T>>;
+    handleTaskResult?: (result: T) => void;
+    limit?: number;
+    options?: {
+        retryCount: number;
+        retryDelay: number;
+    };
+    onError?: (error: unknown) => void;
+}): Promise<void>;
+/**
+ * Assess and log the duration of an asynchronous operation.
+ */
+export declare function measureAsyncOperation<T>(operationName: string, operation: () => Promise<T>, logService: ILogService, warnThresholdMs?: number, startAdditionalInfo?: string): Promise<T>;
+/**
+ * Assess and log the duration of an synchronous operation.
+ */
+export declare function measureSyncOperation<T>(operationName: string, operation: () => T, logService: ILogService, warnThresholdMs?: number, startAdditionalInfo?: string): T;