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

package/lib/types/controllers/board-transform/algorithms/element.algo.d.ts

@@ -0,0 +1,5 @@
+import type { IMutationTransformAlgorithm } from '../../../services/transform/transform.service';
+export declare const RemoveBoardElementMutationWithOthers: IMutationTransformAlgorithm;
+export declare const RemoveBoardElementOnlyMutationWithOthers: IMutationTransformAlgorithm;
+export declare const AddBoardElementMutationWithSelf: IMutationTransformAlgorithm;
+export declare const UpdateBoardElementMutationWithSelf: IMutationTransformAlgorithm;

package/lib/types/controllers/board-transform/algorithms/index.d.ts

@@ -0,0 +1,4 @@
+export { AddBoardElementMutationWithSelf, RemoveBoardElementMutationWithOthers, RemoveBoardElementOnlyMutationWithOthers, UpdateBoardElementMutationWithSelf, } from './element.algo';
+export { RemoveBoardElementMutationWithOrder, RemoveBoardElementOnlyMutationWithOrder } from './order.algo';
+export { RemoveBoardTableMutationWithResource, RemoveBoardTableMutationWithSelf } from './table-resource.algo';
+export declare const BOARD_ALL_ALGORITHMS: import("../../../services/transform/transform.service").IMutationTransformAlgorithm<any, any>[];

package/lib/types/controllers/board-transform/algorithms/order.algo.d.ts

@@ -0,0 +1,3 @@
+import type { IMutationTransformAlgorithm } from '../../../services/transform/transform.service';
+export declare const RemoveBoardElementMutationWithOrder: IMutationTransformAlgorithm;
+export declare const RemoveBoardElementOnlyMutationWithOrder: IMutationTransformAlgorithm;

package/lib/types/controllers/board-transform/algorithms/table-resource.algo.d.ts

@@ -0,0 +1,3 @@
+import type { IMutationTransformAlgorithm } from '../../../services/transform/transform.service';
+export declare const RemoveBoardTableMutationWithResource: IMutationTransformAlgorithm;
+export declare const RemoveBoardTableMutationWithSelf: IMutationTransformAlgorithm;

package/lib/types/controllers/board-transform/algorithms/types.d.ts

@@ -0,0 +1,8 @@
+import type { IMutationInfo } from '@univerjs/core';
+export declare function getBoardUnitId(mutation: IMutationInfo): string | undefined;
+export declare function getBoardPageId(mutation: IMutationInfo): string | undefined;
+export declare function getBoardElementId(mutation: IMutationInfo): string | undefined;
+export declare function getBoardElementIds(mutation: IMutationInfo): string[];
+export declare function sameBoardUnit(m1: IMutationInfo, m2: IMutationInfo): boolean;
+export declare function sameBoardPage(m1: IMutationInfo, m2: IMutationInfo): boolean;
+export declare function boardElementIntersects(m1: IMutationInfo, m2: IMutationInfo): boolean;

package/lib/types/controllers/board-transform/board-transform.controller.d.ts

@@ -0,0 +1,9 @@
+import { Disposable } from '@univerjs/core';
+import { ITransformService } from '../../services/transform/transform.service';
+/**
+ * This controller registers board transform algorithms to the transform service.
+ */
+export declare class BoardTransformController extends Disposable {
+    private readonly _transformService;
+    constructor(_transformService: ITransformService);
+}

package/lib/types/controllers/sheet-transform/sheet-transform.controller.d.ts

@@ -1,6 +1,6 @@
 import { Disposable } from '@univerjs/core';
 import { ITransformService } from '../../services/transform/transform.service';
-export declare const SHEET_ALL_ALGORITHMS: import("../..").IMutationTransformAlgorithm<any, any>[];
+export declare const SHEET_ALL_ALGORITHMS: import("../../services/transform/transform.service").IMutationTransformAlgorithm<any, any>[];
 /**
  * This controller register sheet transform algorithms to the transform service.
  */

package/lib/types/controllers/slide-transform/algorithms/index.d.ts

@@ -1,9 +1,9 @@
 export { UpdateSlidePageBackgroundMutationWithSelf } from './background.algo';
 export { RemoveSlideChartDataSourceMutationWithResource, RemoveSlideChartDataSourceMutationWithSelf, RemoveSlideChartSnapshotMutationWithResource, RemoveSlideChartSnapshotMutationWithSelf, } from './chart-resource.algo';
 export { SetSlideDrawingApplyMutationWithSelf } from './drawing-json.algo';
-export { AddSlideElementMutationWithSelf, RemoveSlideElementMutationWithOthers, UpdateSlideElementMutationWithSelf } from './element.algo';
-export { RemoveSlideElementMutationWithCancelGroup, RemoveSlideElementMutationWithSetGroup, SetSlideGroupMutationWithSelf } from './group.algo';
+export { AddSlideElementMutationWithSelf, RemoveSlideElementMutationWithOthers, UpdateSlideElementMutationWithSelf, } from './element.algo';
+export { RemoveSlideElementMutationWithCancelGroup, RemoveSlideElementMutationWithSetGroup, SetSlideGroupMutationWithSelf, } from './group.algo';
 export { RemoveSlideElementMutationWithOrder } from './order.algo';
-export { AddSlidePageMutationWithSelf, MoveSlidePageMutationWithSelf, RemoveSlidePageMutationWithOthers } from './page.algo';
+export { AddSlidePageMutationWithSelf, MoveSlidePageMutationWithSelf, RemoveSlidePageMutationWithOthers, } from './page.algo';
 export { RemoveSlideTableMutationWithResource, RemoveSlideTableMutationWithSelf } from './table-resource.algo';
-export declare const SLIDE_ALL_ALGORITHMS: import("../../..").IMutationTransformAlgorithm<any, any>[];
+export declare const SLIDE_ALL_ALGORITHMS: import("../../../services/transform/transform.service").IMutationTransformAlgorithm<any, any>[];

package/lib/types/index.d.ts

@@ -1,33 +1,27 @@
 export { CreateUnitMutation } from './commands/create-unit.mutation';
-export type { ICreateUnitMutationParams } from './commands/create-unit.mutation';
 export { RevertRevisionMutation } from './commands/revert-revision.mutation';
 export type { IRevertRevisionMutationParams } from './commands/revert-revision.mutation';
-export type { IUniverCollaborationConfig } from './config/config';
-export { BaseAlgorithms, BaseJson1MutationWithSelf } from './controllers/base-transform/algorithms/base-json1.algo';
 export { BaseTransformController } from './controllers/base-transform/base-transform.controller';
-export { DocAlgorithms, RichTextEditingMutationWithSelf } from './controllers/doc-transform/algorithms/doc-algo';
+export { BoardTransformController } from './controllers/board-transform/board-transform.controller';
+export { RichTextEditingMutationWithSelf } from './controllers/doc-transform/algorithms/doc-algo';
 export { DocTransformController } from './controllers/doc-transform/doc-transform.controller';
 export { EmptyMutationInfo } from './controllers/empty';
 export { SheetTransformController } from './controllers/sheet-transform/sheet-transform.controller';
-export { SLIDE_ALL_ALGORITHMS } from './controllers/slide-transform/algorithms';
 export { SlideTransformController } from './controllers/slide-transform/slide-transform.controller';
-export { parseChangesetToProtocol, parseMutationToProtocol, parseProtocolChangeset, parseProtocolCommand, parseProtocolMutation, } from './models/changeset';
+export { parseChangesetToProtocol, parseMutationToProtocol, parseProtocolChangeset, parseProtocolCommand, } from './models/changeset';
 export type { IChangeset, IFetchMissingCSResult } from './models/changeset';
 export { CollaborationEvent } from './models/collaboration-events';
-export type { IAcknowledgedChangeset, IAcknowledgementEvent, ICollaborationEvent, ICollaborationUser, IFetchingMissEvent, IFetchOperationsEvent, INewChangesetsEvent, INewHostEvent, IOperationEvent, IPermissionUpdateEvent, IPseudoFetchMissingResultEvent, IRejectedChangeset, IRejectionEvent, IRequestHostEvent, IRetryEvent, IShouldCloseConnEvent, ISubmitChangesetEvent, ITerminateEvent, IUpdateCursorEvent, IUserJoinEvent, IUserLeaveEvent, IUserSelectionEvent, } from './models/collaboration-events';
-export { type ICombRequestEvent, type ICombResponseEvent, type IHeartbeatRequestEvent, type IHeartbeatResponseEvent, type IHelloRequestEvent, type IHelloResponseEvent, type IIngestQuestEvent, type IJoinRequestEvent, type IJoinResponseEvent, type ILeaveRequestEvent, type IRecvResponseEvent, } from './models/socket-events';
+export type { IAcknowledgedChangeset, IAcknowledgementEvent, ICollaborationEvent, ICollaborationUser, IFetchingMissEvent, IFetchOperationsEvent, INewChangesetsEvent, INewHostEvent, IOperationEvent, IPermissionUpdateEvent, IPseudoFetchMissingResultEvent, IRejectionEvent, IRequestHostEvent, IRetryEvent, IShouldCloseConnEvent, ISubmitChangesetEvent, ITerminateEvent, IUpdateCursorEvent, IUserJoinEvent, IUserLeaveEvent, } from './models/collaboration-events';
+export type { ICombRequestEvent, ICombResponseEvent, IHeartbeatRequestEvent, IHelloRequestEvent, IHelloResponseEvent, IIngestQuestEvent, IJoinRequestEvent, IJoinResponseEvent, ILeaveRequestEvent, IRecvResponseEvent, } from './models/socket-events';
 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 { RevisionService, SINGLE_HISTORY_MUTATIONS, SINGLE_SNAPSHOT_MUTATIONS, } from './services/rev/rev.service';
 export { SnapshotSaveService } from './services/snapshot/snapshot-save.service';
-export { generateTempBaseSnapshot, generateTempDocumentSnapshot, generateTemporarySnap, getSheetBlocksFromSnapshot, transformBaseDataToSnapshot, transformDocumentDataToSnapshot, transformSlideDataToSnapshot, transformSnapshotToBaseData, transformSnapshotToDocumentData, transformSnapshotToSlideData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot, } from './services/snapshot/snapshot-transform';
-export { decodeSlideOriginalMeta, encodeSlideOriginalMeta, textDecoder, textEncoder, } from './services/snapshot/snapshot-utils';
-export { ISnapshotServerService, SnapshotService } from './services/snapshot/snapshot.service';
-export { ITransformService, TransformService } from './services/transform/transform.service';
-export type { IMutationTransformAlgorithm } from './services/transform/transform.service';
-export { isTransformChangesetsFailure, isTransformChangesetsSuccess, isTransformMutationFailure, isTransformMutationsFailure, isTransformMutationsSuccess, isTransformMutationSuccess, isTransformMutationsWithChangesetFailure, isTransformMutationsWithChangesetSuccess, } from './services/transform/types';
-export type { IFailureTransformChangesetsResult, IFailureTransformMutationResult, IFailureTransformMutationsResult, IFailureTransformMutationsWithChangesetResult, ISuccessTransformChangesetsResult, ISuccessTransformMutationResult, ISuccessTransformMutationsResult, ISuccessTransformMutationsWithChangesetResult, ITransformChangesetsResult, ITransformMutationResult, ITransformMutationsResult, ITransformMutationsWithChangesetResult, } from './services/transform/types';
-export { validateDocBodyAfterApply } from './services/validation/doc-changeset-validation';
-export type { IDocBodyValidationResult } from './services/validation/doc-changeset-validation';
-export { b64DecodeUnicode, b64EncodeUnicode, mapDocumentTypeToUniverInstanceType, measureAsyncOperation, measureSyncOperation, uuidv4, } from './utils';
+export { getSheetBlocksFromSnapshot, transformDocumentDataToSnapshot, transformSlideDataToSnapshot, transformSnapshotToDocumentData, transformSnapshotToSlideData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot, } from './services/snapshot/snapshot-transform';
+export { textDecoder, textEncoder, } from './services/snapshot/snapshot-utils';
+export { ISnapshotServerService, SnapshotService, } from './services/snapshot/snapshot.service';
+export { ITransformService, TransformService, } from './services/transform/transform.service';
+export { isTransformChangesetsFailure, isTransformChangesetsSuccess, isTransformMutationFailure, isTransformMutationsSuccess, isTransformMutationsWithChangesetFailure, isTransformMutationsWithChangesetSuccess, } from './services/transform/types';
+export { validateDocBodyAfterApply, validateDocumentAfterApply } from './services/validation/doc-changeset-validation';
+export { b64DecodeUnicode, b64EncodeUnicode, mapDocumentTypeToUniverInstanceType, measureSyncOperation, uuidv4, } from './utils';
 export type { ILogContext } from './utils';

package/lib/types/models/changeset.d.ts

@@ -1,5 +1,5 @@
 import type { ICommandInfo, IMutationInfo, UniverInstanceType } from '@univerjs/core';
-import type { IChangeset as IProtocolChangeset, ICommand as IProtocolCommand, IMutation as IProtocolMutation } from '@univerjs/protocol';
+import type { ICommand, IMutation, IChangeset as IProtocolChangeset } from '@univerjs/protocol';
 export interface IFetchMissingCSResult {
     changesets: IChangeset[];
     lastRevision?: number;
@@ -21,7 +21,7 @@ export interface IChangeset {
     additionalFields?: string;
 }
 export declare function parseProtocolChangeset(protocolChangeset: IProtocolChangeset): IChangeset;
-export declare function parseProtocolCommand(protocolCommands: IProtocolCommand[]): ICommandInfo[];
+export declare function parseProtocolCommand(protocolCommands: ICommand[]): ICommandInfo[];
 export declare function parseChangesetToProtocol(changeset: IChangeset): IProtocolChangeset;
-export declare function parseProtocolMutation(mutation: IProtocolMutation): IMutationInfo;
-export declare function parseMutationToProtocol(mutation: IMutationInfo): IProtocolMutation;
+export declare function parseProtocolMutation(mutation: IMutation): IMutationInfo;
+export declare function parseMutationToProtocol(mutation: IMutationInfo): IMutation;

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

@@ -1,3 +1,4 @@
+import type { IBoardData } from '@univerjs-pro/boards';
 import type { ISlideData } from '@univerjs-pro/slides';
 import type { BaseDataModel, DocumentDataModel, IBaseSnapshot, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
 import type { ISheetBlockMeta, ISnapshot } from '@univerjs/protocol';
@@ -42,4 +43,7 @@ export declare class SnapshotSaveService {
     saveSlide(unitId: string, slideData: ISlideData, rev: number): Promise<{
         snapshot: ISnapshot;
     }>;
+    saveBoard(unitId: string, boardData: IBoardData, rev: number): Promise<{
+        snapshot: ISnapshot;
+    }>;
 }

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

@@ -1,3 +1,4 @@
+import type { IBoardData } from '@univerjs-pro/boards';
 import type { ISlideData } from '@univerjs-pro/slides';
 import type { IBaseSnapshot, IDocumentData, ILogService, IWorkbookData } from '@univerjs/core';
 import type { IDeserializedSheetBlock, ISheetBlock, ISheetBlockMeta, ISnapshot } from '@univerjs/protocol';
@@ -36,6 +37,10 @@ export declare function transformSlideDataToSnapshot(_resources: ISlideData['res
     snapshot: ISnapshot;
 }>;
 export declare function transformSnapshotToSlideData(snapshot: ISnapshot): ISlideData;
+export declare function transformBoardDataToSnapshot(_resources: IBoardData['resources'], boardData: IBoardData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
+    snapshot: ISnapshot;
+}>;
+export declare function transformSnapshotToBoardData(snapshot: ISnapshot): IBoardData;
 /**
  *
  * @param snapshot

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

@@ -1,3 +1,4 @@
+import type { IBoardData } from '@univerjs-pro/boards';
 import type { ISlideData } from '@univerjs-pro/slides';
 import type { ICellData, IDocumentData, IObjectMatrixPrimitiveType, IWorkbookData, IWorksheetData } from '@univerjs/core';
 import type { ISheetBlock } from '@univerjs/protocol';
@@ -10,11 +11,13 @@ export declare function encodeWorksheetOtherMetas(worksheet: Partial<IWorksheetD
 export declare function encodeWorkbookOtherMetas(workbook: IWorkbookData): Uint8Array;
 export declare function encodeDocOriginalMeta(document: IDocumentData): Uint8Array;
 export declare function encodeSlideOriginalMeta(slide: ISlideData): Uint8Array;
+export declare function encodeBoardOriginalMeta(board: IBoardData): Uint8Array;
 export declare function decodeWorksheetOtherMetas(buffer: Uint8Array | string): Partial<IWorksheetData>;
 export declare function decodeWorkbookOtherMetas(buffer: Uint8Array | string): Partial<IWorkbookData>;
 export declare function decodePartOfCellData(buffer: Uint8Array | object): IObjectMatrixPrimitiveType<ICellData>;
 export declare function decodeDocOriginalMeta(buffer: Uint8Array | string): Partial<IDocumentData>;
 export declare function decodeSlideOriginalMeta(buffer: Uint8Array | string): ISlideData;
+export declare function decodeBoardOriginalMeta(buffer: Uint8Array | string): IBoardData;
 export declare function splitCellDataToBlocks(cellData: IObjectMatrixPrimitiveType<ICellData>, fragmentCellCount?: number, minBlockSize?: number): {
     blocks: ISheetBlock[];
     totalCells: number;

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

@@ -1,11 +1,13 @@
+import type { BoardModel, IBoardData } from '@univerjs-pro/boards';
 import type { ISlideData, SlideModel } from '@univerjs-pro/slides';
-import type { BaseDataModel, DocumentDataModel, IBaseSnapshot, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
+import type { BaseDataModel, DocumentDataModel, IBaseSnapshot, ICreateUnitOptions, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
 import type { ICopyFileMetaRequest, ICopyFileMetaResponse, IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetDeserializedSheetBlockResponse, IGetLatestCsReqIdBySidRequest, IGetLatestCsReqIdBySidResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, IReportUnitRoutingStatsRequest, IReportUnitRoutingStatsResponse, ISaveChangesetRequest, ISaveChangesetResponse, ISaveSheetBlockRequest, ISaveSheetBlockResponse, ISaveSnapshotRequest, ISaveSnapshotResponse, ISnapshot } from '@univerjs/protocol';
 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';
 export declare function hasSlideSnapshotMeta(snapshot: ISnapshot | null | undefined): boolean;
+export declare function hasBoardSnapshotMeta(snapshot: ISnapshot | null | undefined): boolean;
 /**
  * It provides implementations for server side controllers to load or save
  * or load snapshots. This service should be implemented by the host environment.
@@ -34,6 +36,9 @@ export interface ISnapshotServerService {
     /** Report unit routing stats */
     reportUnitRoutingStats?: (context: ILogContext, params: IReportUnitRoutingStatsRequest) => Promise<IReportUnitRoutingStatsResponse>;
 }
+export interface ISnapshotLoadOptions {
+    createOptions?: ICreateUnitOptions;
+}
 /**
  * The service provides methods to load snapshots from the snapshot server.
  */
@@ -46,14 +51,18 @@ export declare class SnapshotService {
     private _compressMutationService;
     private _resourceManagerService;
     constructor(_revisionService: RevisionService, _univerInstanceService: IUniverInstanceService, _snapshotServerService: ISnapshotServerService, _commandService: ICommandService, _logService: ILogService, _compressMutationService: CompressMutationService, _resourceManagerService: IResourceManagerService);
-    loadSheet(unitId: string, rev: number, context?: ILogContext): Promise<Workbook>;
-    loadBase(unitId: string, rev: number, context?: ILogContext): Promise<BaseDataModel>;
-    loadDoc(unitID: string, rev: number, context?: ILogContext): Promise<DocumentDataModel>;
-    loadSlide(unitID: string, rev?: number, context?: ILogContext): Promise<SlideModel>;
+    loadSheet(unitId: string, rev: number, context?: ILogContext, options?: ISnapshotLoadOptions): Promise<Workbook>;
+    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>;
     saveSheet(_context: ILogContext, workbook: Workbook): IWorkbookData;
     saveBase(_context: ILogContext, base: BaseDataModel): IBaseSnapshot;
     saveDoc(_context: ILogContext, document: DocumentDataModel): IDocumentData;
     saveSlide(unitId: string, slideData: ISlideData, rev: number): Promise<{
         snapshot: ISnapshot;
     }>;
+    saveBoard(unitId: string, boardData: IBoardData, rev: number): Promise<{
+        snapshot: ISnapshot;
+    }>;
 }

package/lib/types/services/validation/doc-changeset-validation.d.ts

@@ -1,6 +1,7 @@
-import type { IDocumentBody } from '@univerjs/core';
+import type { IDocumentBody, IDocumentData } from '@univerjs/core';
 export interface IDocBodyValidationResult {
     ok: boolean;
     errors: string[];
 }
 export declare function validateDocBodyAfterApply(body: IDocumentBody): IDocBodyValidationResult;
+export declare function validateDocumentAfterApply(snapshot: Pick<IDocumentData, 'body' | 'headers' | 'footers' | 'tableSource'>): IDocBodyValidationResult;