@univerjs-pro/collaboration 0.5.0-nightly.202411120616 → 0.5.0-nightly.202411131606

package/lib/types/index.d.ts

@@ -1,716 +1,17 @@
-import { CmdRspCode } from '@univerjs/protocol';
-import { CombCmd } from '@univerjs/protocol';
-import { Disposable as Disposable_2 } from '@univerjs/core';
-import { DocumentDataModel } from '@univerjs/core';
-import { IChangeset as IChangeset_2 } from '@univerjs/protocol';
-import { ICollaMsgErrorEvent } from '@univerjs/protocol';
-import { ICollaMsgJoin } from '@univerjs/protocol';
-import { ICollaMsgLeave } from '@univerjs/protocol';
-import { ICombJoinRequest } from '@univerjs/protocol';
-import { ICombJoinResponse } from '@univerjs/protocol';
-import { ICombLeaveRequest } from '@univerjs/protocol';
-import { ICommand } from '@univerjs/protocol';
-import { ICommandInfo } from '@univerjs/core';
-import { ICommandService } from '@univerjs/core';
-import { ICommentUpdate } from '@univerjs/protocol';
-import { IConfigService } from '@univerjs/core';
-import { ICopyFileMetaRequest } from '@univerjs/protocol';
-import { ICopyFileMetaResponse } from '@univerjs/protocol';
-import { ICreateHistoryRequest } from '@univerjs/protocol';
-import { ICreateHistoryResponse } from '@univerjs/protocol';
-import { IdentifierDecorator } from '@wendellhu/redi';
-import { IDeserializedSheetBlock } from '@univerjs/protocol';
-import { IDocumentData } from '@univerjs/core';
-import { IFetchMissingChangesetsRequest } from '@univerjs/protocol';
-import { IFetchMissingChangesetsResponse } from '@univerjs/protocol';
-import { IGetDeserializedSheetBlockResponse } from '@univerjs/protocol';
-import { IGetLatestCsReqIdBySidRequest } from '@univerjs/protocol';
-import { IGetLatestCsReqIdBySidResponse } from '@univerjs/protocol';
-import { IGetResourcesRequest } from '@univerjs/protocol';
-import { IGetResourcesResponse } from '@univerjs/protocol';
-import { IGetSheetBlockRequest } from '@univerjs/protocol';
-import { IGetSheetBlockResponse } from '@univerjs/protocol';
-import { IGetUnitOnRevRequest } from '@univerjs/protocol';
-import { IGetUnitOnRevResponse } from '@univerjs/protocol';
-import { IInterceptor } from '@univerjs/core';
-import { ILiveShareNewHost } from '@univerjs/protocol';
-import { ILiveShareOperation } from '@univerjs/protocol';
-import { ILiveShareRequestHost } from '@univerjs/protocol';
-import { ILiveShareTerminate } from '@univerjs/protocol';
-import { IMutation } from '@univerjs/protocol';
-import { IMutation as IMutation_2 } from '@univerjs/core';
-import { IMutationInfo } from '@univerjs/core';
-import { Injector } from '@univerjs/core';
-import { InterceptorManager } from '@univerjs/core';
-import { IResourceManagerService } from '@univerjs/core';
-import { ISaveChangesetRequest } from '@univerjs/protocol';
-import { ISaveChangesetResponse } from '@univerjs/protocol';
-import { ISaveSheetBlockRequest } from '@univerjs/protocol';
-import { ISaveSheetBlockResponse } from '@univerjs/protocol';
-import { ISaveSnapshotRequest } from '@univerjs/protocol';
-import { ISaveSnapshotResponse } from '@univerjs/protocol';
-import { ISheetBlock } from '@univerjs/protocol';
-import { IShouldCloseConn } from '@univerjs/protocol';
-import { ISnapshot } from '@univerjs/protocol';
-import { IUniverInstanceService } from '@univerjs/core';
-import { IUpdateCursor } from '@univerjs/protocol';
-import { IUpdatePermissionObj } from '@univerjs/protocol';
-import { IWorkbookData } from '@univerjs/core';
-import { Plugin as Plugin_2 } from '@univerjs/core';
-import { UniverInstanceType } from '@univerjs/core';
-import { UniverType } from '@univerjs/protocol';
-import { Workbook } from '@univerjs/core';
-
-export declare function b64DecodeUnicode(str: string): string;
-
-export declare function b64EncodeUnicode(str: string): string;
-
-/**
- * Types of all possible collaboration events.
- *
- * CollaborationEvents is a subset of `CombEvent.RECV`.
- */
-export declare enum CollaborationEvent {
-    /**
-     * When the collaboration session is created, the client may send this event to the server.
-     * In the payload, the client will tell the server the its local revision. The server
-     * could emit missing changesets to the client using event `NEW_CHANGESETS`.
-     */
-    FETCH_MISSING = "fetch_missing",
-    /* Excluded from this release type: PSEUDO_FETCH_MISSING_RESULT */
-    /**
-     * The client submit a changeset to the server.
-     */
-    SUBMIT_CHANGESET = "submit_changeset",
-    /**
-     * The submitted changeset is acknowledged by the server.
-     */
-    CHANGESET_ACK = "changeset_ack",
-    /**
-     * The submitted changeset could not be transformed by the server, so
-     * the changeset should be rejected.
-     */
-    CHANGESET_REJ = "changeset_rej",
-    /**
-     * The submitted changeset could not be acknowledged by unexpected server error, so
-     * the changeset should be resent.
-     */
-    CHANGESET_SHOULD_RETRY = "changeset_should_retry",
-    /**
-     * When a changeset sent by the client is acknowledged by the server,
-     * the server should broadcast this changeset to other clients.
-     *
-     * Note that this event would not be sent via the websocket but http.
-     */
-    NEW_CHANGESETS = "new_changesets",
-    /**
-     * When a client updates its cursor position, it would send this event to
-     * the server. The server would also broadcast this event to other peer
-     * clients.
-     */
-    UPDATE_CURSOR = "update_cursor",
-    /**
-     * When a client connect the collaboration session, the server should
-     * broadcast this event to all other clients.
-     */
-    USERS_ENTER = "users_enter",
-    /**
-     * When a client disconnect the collaboration session, the server should
-     * broadcast this event to all other clients.
-     */
-    USERS_LEAVE = "users_leave",
-    /**
-     * The collaboration unit is deleted on the server.
-     */
-    UNIT_DELETE = "unit_delete",
-    /**
-     * This client requests itself to be the live share host. Sent by clients.
-     */
-    LIVESHARE_REQUEST_HOST = "liveshare.request_host",
-    /**
-     * New host is elected. Sent by the server.
-     */
-    LIVESHARE_NEW_HOST = "liveshare.new_host",
-    /**
-     * A operation sent from the live share host. Sent by the host client and
-     * broadcasted by the server. For each `operation.id`, the server should
-     * cache let latest value for followers who come into the live share room
-     * later.
-     */
-    LIVESHARE_OPERATION = "liveshare.operation",
-    /**
-     * Fetch all operations from the live share host. for some scenarios:
-     * 1. when a client comes into the live share room, it should fetch all
-     * 2. when a client miss some operations, it should fetch all
-     */
-    LIVESHARE_FETCH_OPERATIONS = "liveshare.fetch_operations",
-    /**
-     * Send by the presenter to terminate live share. Should be broadcasted to
-     * all followers.
-     */
-    LIVESHARE_TERMINATE = "liveshare.terminate",
-    /**
-     * This type will be returned if an error is reported.
-     */
-    MSG_FOR_ERROR = "error_msg",
-    PERMISSION_REJ = "permission_rej",
-    COMMENT_UPDATE = "comment_update",
-    UPDATE_PERMISSION_OBJ = "update_permission_obj",
-    SHOULD_CLOSE_CONN = "should_close_conn"
-}
-
-/**
- * During transmission, compression is performed for a specific operation,referencing during transport.
- * Before send -> compress -> transmission -> ... -> node apply -> decompression -> apply.
- * Before send -> compress -> transmission -> ... -> node transform -> decompression -> apply.
- * Before send -> compress -> transmission -> ... -> take from server -> decompression -> apply.
- * Before send -> compress -> save to local -> ... -> take from local -> decompression -> apply.
- * @export
- * @class CompressMutationService
- */
-export declare class CompressMutationService {
-    interceptor: InterceptorManager<{
-        COMPRESS_MUTATION_APPLY: IInterceptor<IMutationInfo<object>[], null>;
-        COMPRESS_MUTATION_SEND: IInterceptor<IMutationInfo<object>[], null>;
-    }>;
-    constructor();
-    private _init;
-    private _initSetRangeValues;
-}
-
-/**
- * This mutation will not create a unit but only be a signal
- */
-export declare const CreateUnitMutation: IMutation_2<ICreateUnitMutationParams>;
-
-/**
- * This controller register sheet transform algorithms to the transform service.
- */
-export declare class DocTransformController extends Disposable_2 {
-    private readonly _transformService;
-    constructor(_transformService: ITransformService);
-}
-
-export declare function generateTempDocumentSnapshot(_context: ILogContext, document: IDocumentData, unitID: string, rev: number): Promise<{
-    snapshot: ISnapshot;
-}>;
-
-export declare function generateTemporarySnap(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
-    snapshot: ISnapshot;
-}>;
-
-/**
- *
- * @param snapshot
- * @param snapshotService
- * @returns
- */
-export declare function getSheetBlocksFromSnapshot(snapshot: ISnapshot, snapshotService: ISnapshotServerService): Promise<ISheetBlock[]>;
-
-/**
- * Awaiting mutations were acknowledged by the server.
- */
-export declare interface IAcknowledgedChangeset {
-    /** The rev of the document when this changeset is assembled. */
-    baseRev: number;
-    /** The rev version given by the server. */
-    revision: number;
-}
-
-export declare interface IAcknowledgementEvent {
-    eventID: CollaborationEvent.CHANGESET_ACK;
-    data: IChangeset_2;
-}
-
-export declare interface IChangeset {
-    unitID: string;
-    type: UniverType;
-    baseRev: number;
-    revision: number;
-    userID: string;
-    mutations: IMutationInfo[];
-    memberID: string;
-    /** sid works with reqId, represent the id of a unit edit session */
-    sid?: string;
-    /** reqId works with sid, should be monotonically increasing and begin with 1 in the same edit session */
-    reqId?: number;
-}
-
-/**
- * A union type of all possible collaboration events.
- */
-export declare type ICollaborationEvent = IAcknowledgementEvent | INewChangesetsEvent | IRejectionEvent | ISubmitChangesetEvent | IPseudoFetchMissingResultEvent | IUserSelectionEvent | IFetchingMissEvent | IUpdateCursorEvent | IUserJoinEvent | IUserLeaveEvent | ICustomEvent | IRequestHostEvent | IFetchOperationsEvent | ITerminateEvent | INewHostEvent | IOperationEvent | IMsgErrEvent | ICommentUpdateEvent | IPermissionUpdateEvent | IShouldCloseConnEvent;
-
-export declare interface ICollaborationUser {
-    userID: string;
-    memberID: string;
-    name: string;
-}
-
-declare interface ICombCmdRequest {
-    cmd: CombCmd;
-    routeKey: string;
-    routeType: string;
-    data?: unknown;
-}
-
-declare interface ICombCmdResponse {
-    cmd: CombCmd;
-    code: CmdRspCode;
-    routeKey: string;
-    data?: unknown;
-}
-
-export declare type ICombRequestEvent = IHelloRequestEvent | IJoinRequestEvent | ILeaveRequestEvent | IIngestQuestEvent | IHeartbeatRequestEvent;
-
-export declare type ICombResponseEvent = IHelloResponseEvent | IJoinResponseEvent | IRecvResponseEvent | IHeartbeatResponseEvent;
-
-declare interface ICommentUpdateEvent {
-    eventID: CollaborationEvent.COMMENT_UPDATE;
-    data: ICommentUpdate;
-}
-
-export declare interface ICreateUnitMutationParams {
-    unitId: string;
-}
-
-/**
- * The special type for other features to reuse collaboration session.
- */
-declare interface ICustomEvent {
-    eventID: string;
-    data: any;
-}
-
-export declare interface IFailureTransformChangesetsResult {
-    error: Error;
-}
-
-export declare interface IFailureTransformMutationResult {
-    error: Error;
-}
-
-export declare interface IFailureTransformMutationsResult {
-    error: Error;
-}
-
-export declare interface IFailureTransformMutationsWithChangesetResult {
-    error: Error;
-}
-
-/**
- * When the collaboration session is created, it should send a handshake event to the server.
- */
-export declare interface IFetchingMissEvent {
-    eventID: CollaborationEvent.FETCH_MISSING;
-    data: {
-        unitID: string;
-        unitType: UniverType;
-        from: number;
-        to: number;
-    };
-}
-
-export declare interface IFetchOperationsEvent {
-    eventID: CollaborationEvent.LIVESHARE_FETCH_OPERATIONS;
-}
-
-export declare interface IHeartbeatRequestEvent extends ICombCmdRequest {
-    cmd: CombCmd.HEARTBEAT;
-}
-
-export declare interface IHeartbeatResponseEvent extends ICombCmdResponse {
-    cmd: CombCmd.HEARTBEAT;
-}
-
-export declare interface IHelloRequestEvent extends ICombCmdRequest {
-    cmd: CombCmd.HELLO;
-}
-
-export declare interface IHelloResponseEvent extends ICombCmdResponse {
-    cmd: CombCmd.HELLO;
-    /** The client will not send `data` but the server would respond with `data`. */
-    data: {
-        memberID: string;
-    };
-}
-
-export declare interface IHistoryIoService {
-    createHistory(config: ICreateHistoryRequest, context?: ILogContext): Promise<ICreateHistoryResponse>;
-}
-
-export declare const IHistoryIoService: IdentifierDecorator<IHistoryIoService>;
-
-export declare interface IIngestQuestEvent extends ICombCmdRequest {
-    cmd: CombCmd.INGEST;
-    data: ICollaborationEvent;
-}
-
-export declare interface IJoinRequestEvent extends ICombCmdRequest {
-    cmd: CombCmd.JOIN;
-    data: ICombJoinRequest;
-}
-
-export declare interface IJoinResponseEvent extends ICombCmdResponse {
-    cmd: CombCmd.JOIN;
-    data: ICombJoinResponse;
-}
-
-export declare interface ILeaveRequestEvent extends ICombCmdRequest {
-    cmd: CombCmd.LEAVE;
-    data: ICombLeaveRequest;
-}
-
-export declare interface ILogContext {
-    metadata?: Record<string, string>;
-}
-
-declare interface IMsgErrEvent {
-    eventID: CollaborationEvent.MSG_FOR_ERROR;
-    data: ICollaMsgErrorEvent;
-}
-
-/**
- * A single transform algorithm. Algorithms are registered to the transform service in the form of `{m1}-{m2}`.
- * When the transform service is transforming two mutations, it would find the algorithm by the form of `{m1}-{m2}`.
- * `m1` is the mutation on the left side, and `m2` is the mutation on the right side.
- */
-export declare interface IMutationTransformAlgorithm<M extends object = any, N extends object = any> {
-    m1: string;
-    m2?: string | 'any';
-    handler(m1: IMutationInfo<M>, m2: IMutationInfo<N>): ITransformMutationResult;
-    handler(m1: IMutationInfo<M>, m2: IMutationInfo<N>, onlyLater?: true): Omit<ISuccessTransformMutationResult, 'm1Prime'> | IFailureTransformMutationResult;
-}
-
-/** Receives a changeset from collaboration server. */
-export declare interface INewChangesetsEvent {
-    eventID: CollaborationEvent.NEW_CHANGESETS;
-    data: IChangeset_2;
-}
-
-export declare interface INewHostEvent {
-    eventID: CollaborationEvent.LIVESHARE_NEW_HOST;
-    data: ILiveShareNewHost;
-}
-
-export declare interface IOperationEvent {
-    eventID: CollaborationEvent.LIVESHARE_OPERATION;
-    data: ILiveShareOperation;
-}
-
-export declare interface IPermissionUpdateEvent {
-    eventID: CollaborationEvent.UPDATE_PERMISSION_OBJ;
-    data: IUpdatePermissionObj;
-}
-
-export declare interface IPseudoFetchMissingResultEvent {
-    eventID: CollaborationEvent.PSEUDO_FETCH_MISSING_RESULT;
-    data: {
-        changesets: IChangeset_2[];
-    };
-}
-
-export declare interface IRecvResponseEvent extends ICombCmdResponse {
-    cmd: CombCmd.RECV;
-    data: ICollaborationEvent;
-}
-
-/**
- * Awaiting mutations were rejected by the server.
- */
-export declare interface IRejectedChangeset {
-    baseRev: number;
-    revision: number;
-}
-
-export declare interface IRejectionEvent {
-    eventID: CollaborationEvent.CHANGESET_REJ;
-    data: {
-        unitID: string;
-        changeset: IRejectedChangeset;
-    };
-}
-
-export declare interface IRequestHostEvent {
-    eventID: CollaborationEvent.LIVESHARE_REQUEST_HOST;
-    data: ILiveShareRequestHost;
-}
-
-export declare interface IRetryEvent {
-    eventID: CollaborationEvent.CHANGESET_SHOULD_RETRY;
-    data: IChangeset;
-}
-
-export declare interface IRevertRevisionMutationParams {
-    unitId: string;
-    revision: number;
-}
-
-export declare interface IShouldCloseConnEvent {
-    eventID: CollaborationEvent.SHOULD_CLOSE_CONN;
-    data: IShouldCloseConn;
-}
-
-/**
- * It provides implementations for server side controllers to load or save
- * or load snapshots. This service should be implemented by the host environment.
- * And it shouldn't contain any business logic.
- */
-export declare const ISnapshotServerService: IdentifierDecorator<ISnapshotServerService>;
-
-export declare interface ISnapshotServerService {
-    /** Load snapshot from a database. */
-    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>;
-    /** Fetch missing changeset */
-    fetchMissingChangesets: (context: ILogContext, params: IFetchMissingChangesetsRequest) => Promise<IFetchMissingChangesetsResponse>;
-    getResourcesRequest: (context: ILogContext, params: IGetResourcesRequest) => Promise<IGetResourcesResponse>;
-    /** Save snapshot to a database. */
-    saveSnapshot: (context: ILogContext, params: ISaveSnapshotRequest) => Promise<ISaveSnapshotResponse>;
-    /** Save sheet block to a database. */
-    saveSheetBlock: (context: ILogContext, params: ISaveSheetBlockRequest) => Promise<ISaveSheetBlockResponse>;
-    /** Save changeset to a database. */
-    saveChangeset: (context: ILogContext, params: ISaveChangesetRequest) => Promise<ISaveChangesetResponse>;
-    copyFileMeta: (context: ILogContext, params: ICopyFileMetaRequest) => Promise<ICopyFileMetaResponse>;
-    getLatestCsReqIdBySid: (context: ILogContext, params: IGetLatestCsReqIdBySidRequest) => Promise<IGetLatestCsReqIdBySidResponse>;
-}
-
-export declare function isTransformChangesetsFailure(result: Partial<ITransformChangesetsResult>): result is IFailureTransformChangesetsResult;
-
-export declare function isTransformChangesetsSuccess(result: Partial<ITransformChangesetsResult>): result is ISuccessTransformChangesetsResult;
-
-export declare function isTransformMutationFailure(result: ITransformMutationResult | Omit<ISuccessTransformMutationResult, 'm1Prime'>): result is IFailureTransformMutationResult;
-
-export declare function isTransformMutationsFailure(result: Partial<ITransformMutationsResult>): result is IFailureTransformMutationsResult;
-
-export declare function isTransformMutationsSuccess(result: Partial<ITransformMutationsResult>): result is ISuccessTransformMutationsResult;
-
-export declare function isTransformMutationSuccess(result: ITransformMutationResult | Omit<ISuccessTransformMutationResult, 'm1Prime'>): result is ISuccessTransformMutationResult;
-
-export declare function isTransformMutationsWithChangesetFailure(result: ITransformMutationsWithChangesetResult): result is IFailureTransformMutationsWithChangesetResult;
-
-export declare function isTransformMutationsWithChangesetSuccess(result: ITransformMutationsWithChangesetResult): result is ISuccessTransformMutationsWithChangesetResult;
-
-/** Send a changeset to the collaboration sever. */
-export declare interface ISubmitChangesetEvent {
-    eventID: CollaborationEvent.SUBMIT_CHANGESET;
-    data: {
-        unitID: string;
-        unitType: UniverType;
-        memberID: string;
-        changeset: IChangeset;
-    };
-}
-
-export declare interface ISuccessTransformChangesetsResult {
-    c1Prime: IChangeset[];
-    c2Prime: IChangeset[];
-}
-
-export declare interface ISuccessTransformMutationResult {
-    m1Prime: IMutationInfo | IMutationInfo[];
-    m2Prime: IMutationInfo | IMutationInfo[];
-}
-
-export declare interface ISuccessTransformMutationsResult {
-    m1Prime: IMutationInfo[];
-    m2Prime: IMutationInfo[];
-}
-
-export declare interface ISuccessTransformMutationsWithChangesetResult {
-    c1Prime: IChangeset;
-    m2Prime: IMutationInfo[];
-}
-
-export declare interface ITerminateEvent {
-    eventID: CollaborationEvent.LIVESHARE_TERMINATE;
-    data: ILiveShareTerminate;
-}
-
-export declare type ITransformChangesetsResult = ISuccessTransformChangesetsResult | IFailureTransformChangesetsResult;
-
-export declare type ITransformMutationResult = ISuccessTransformMutationResult | IFailureTransformMutationResult;
-
-export declare type ITransformMutationsResult = ISuccessTransformMutationsResult | IFailureTransformMutationsResult;
-
-export declare type ITransformMutationsWithChangesetResult = ISuccessTransformMutationsWithChangesetResult | IFailureTransformMutationsWithChangesetResult;
-
-/**
- * This service's responsibility is to transform mutations (changesets).
- *
- * Features could register transform algorithms to this service, so this the service could transform more mutations.
- *
- * This should be used both on client and server.
- *
- * This service is also business-agnostic, so it could be used in docs, sheets and slides.
- */
-export declare interface ITransformService {
-    /**
-     * Register an algorithm to transform two kinds of mutations.
-     *
-     * Note that this method is not the same as other registering methods in Univer, it wouldn't return a disposable,
-     * because it would cause critical problems if you unregister a transform algorithm.
-     */
-    registerTransformAlgorithm: (algorithms: IMutationTransformAlgorithm) => void;
-    /* Excluded from this release type: transformMutation */
-    transformMutation(m1: IMutationInfo, m2: IMutationInfo, onlyLater: false): ITransformMutationResult;
-    /* Excluded from this release type: transformMutations */
-    transformMutations(m1: IMutationInfo[], m2: IMutationInfo[], onlyLater: boolean): ITransformMutationsResult;
-    /* Excluded from this release type: transformChangesets */
-    transformChangesets(c1: IChangeset[], c2: IChangeset[], onlyLater: false): ITransformChangesetsResult;
-    /* Excluded from this release type: transformMutationsWithChangeset */
-}
-
-export declare const ITransformService: IdentifierDecorator<ITransformService>;
-
-declare interface IUniverCollaborationConfig {
-}
-
-export declare interface IUpdateCursorEvent {
-    eventID: CollaborationEvent.UPDATE_CURSOR;
-    data: IUpdateCursor;
-}
-
-export declare interface IUserJoinEvent {
-    eventID: CollaborationEvent.USERS_ENTER;
-    data: ICollaMsgJoin;
-}
-
-export declare interface IUserLeaveEvent {
-    eventID: CollaborationEvent.USERS_LEAVE;
-    data: ICollaMsgLeave;
-}
-
-export declare interface IUserSelectionEvent {
-    eventID: CollaborationEvent.UPDATE_CURSOR;
-    data: {
-        /** The selection is serialized. */
-        selection: string;
-        userID: string;
-        memberID: string;
-        unitID: string;
-    };
-}
-
-export declare function makeArray<T>(input: T | T[]): T[];
-
-export declare function mapDocumentTypeToUniverType(documentType: UniverInstanceType): UniverType;
-
-export declare function parseChangesetToProtocol(changeset: IChangeset): IChangeset_2;
-
-export declare function parseMutationToProtocol(mutation: IMutationInfo): IMutation;
-
-export declare function parseProtocolChangeset(protocolChangeset: IChangeset_2): IChangeset;
-
-export declare function parseProtocolCommand(protocolCommands: ICommand[]): ICommandInfo[];
-
-export declare function parseProtocolMutation(mutation: IMutation): IMutationInfo;
-
-export declare const RevertRevisionMutation: IMutation_2<IRevertRevisionMutationParams>;
-
-/**
- * This service provide util functions to get revision number of a document or increment the revision number.
- */
-export declare class RevisionService {
-    private readonly _univerInstanceService;
-    constructor(_univerInstanceService: IUniverInstanceService);
-    /**
-     * Get the current revision of a document.
-     * @param unitId
-     */
-    getCurrentRevOfUnit(unitId: string): number;
-    /**
-     * Increment the revision number of a document.
-     * @param unitId
-     * @returns The revision number after increment.
-     */
-    incrementRevOfUnit(unitId: string): number;
-    setRevOfUnit(unitId: string, rev: number): void;
-}
-
-/**
- * This controller register sheet transform algorithms to the transform service.
- */
-export declare class SheetTransformController extends Disposable_2 {
-    private readonly _transformService;
-    constructor(_transformService: ITransformService);
-}
-
-export declare const SINGLE_HISTORY_MUTATIONS: Set<string>;
-
-/** Some special mutations. It a changeset contains the following mutations it should create a snapshot immediately. */
-export declare const SINGLE_SNAPSHOT_MUTATIONS: Set<string>;
-
-/**
- * The service provides methods to load snapshots from the snapshot server.
- */
-export declare class SnapshotService {
-    private readonly _revisionService;
-    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);
-    loadSheet(unitID: string, rev: number, context?: ILogContext): Promise<Workbook>;
-    loadDoc(unitID: string, rev: number, context?: ILogContext): Promise<DocumentDataModel>;
-    save(_context: ILogContext, workbook: Workbook): IWorkbookData;
-    saveDoc(_context: ILogContext, document: DocumentDataModel): IDocumentData;
-}
-
-export declare const textDecoder: TextDecoder;
-
-export declare const textEncoder: TextEncoder;
-
-export declare function transformDocumentDataToSnapshot(context: ILogContext, document: IDocumentData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
-    snapshot: ISnapshot;
-}>;
-
-export declare class TransformService extends Disposable_2 implements ITransformService {
-    private readonly _transformMap;
-    dispose(): void;
-    registerTransformAlgorithm(algorithm: IMutationTransformAlgorithm): void;
-    transformMutation(m1: IMutationInfo, m2: IMutationInfo): ITransformMutationResult;
-    transformMutation(m1: IMutationInfo, m2: IMutationInfo, onlyLater: true): IFailureTransformMutationResult | Omit<ISuccessTransformMutationResult, 'm1Prime'>;
-    transformMutations(m1: IMutationInfo[], m2: IMutationInfo[]): ITransformMutationsResult;
-    transformMutations(m1: IMutationInfo[], m2: IMutationInfo[], onlyLater: true): IFailureTransformMutationsResult | Omit<ISuccessTransformMutationsResult, 'm1Prime'>;
-    /**
-     * Assume `m1` has already applied to the document, we need m2Prime to be applied to the document.
-     *
-     * @param m1
-     * @param m2
-     * @returns transformed mutations of m2
-     */
-    private _rightInclineTransformMutations;
-    private _leftInclineTransformMutations;
-    transformChangesets(c1: IChangeset[], c2: IChangeset[]): ITransformChangesetsResult;
-    transformChangesets(c1: IChangeset[], c2: IChangeset[], onlyLater: true): IFailureTransformChangesetsResult | Omit<ISuccessTransformChangesetsResult, 'c1Prime'>;
-    transformMutationsWithChangeset(c1: IChangeset, m2: IMutationInfo[]): ITransformMutationsWithChangesetResult;
-}
-
-export declare function transformSnapshotToDocumentData(snapshot: ISnapshot): IDocumentData;
-
-/**
- * Assemble a snapshot to a workbook.
- * @param snapshot
- * @param sheetBlocks
- */
-export declare function transformSnapshotToWorkbookData(snapshot: ISnapshot, sheetBlocks: (IDeserializedSheetBlock | ISheetBlock)[], _context?: ILogContext): IWorkbookData;
-
-export declare function transformWorkbookDataToSnapshot(context: ILogContext, workbook: IWorkbookData, unitID: string, rev: number, snapshotService: ISnapshotServerService): Promise<{
-    snapshot: ISnapshot;
-}>;
-
-export declare class UniverCollaborationPlugin extends Plugin_2 {
-    private readonly _config;
-    protected _injector: Injector;
-    private readonly _configService;
-    static pluginName: string;
-    constructor(_config: IUniverCollaborationConfig | undefined, _injector: Injector, _configService: IConfigService);
-    onStarting(): void;
-}
-
-export { }
+export { SheetTransformController } from './controllers/sheet-transform/sheet-transform.controller';
+export { DocTransformController } from './controllers/doc-transform/doc-transform.controller';
+export { type IChangeset, parseChangesetToProtocol, parseMutationToProtocol, parseProtocolChangeset, parseProtocolCommand, parseProtocolMutation, } from './models/changeset';
+export { CollaborationEvent, type IAcknowledgedChangeset, type IAcknowledgementEvent, type ICollaborationEvent, type ICollaborationUser, type IFetchingMissEvent, type IFetchOperationsEvent, type INewChangesetsEvent, type INewHostEvent, type IOperationEvent, type IPermissionUpdateEvent, type IPseudoFetchMissingResultEvent, type IRejectedChangeset, type IRejectionEvent, type IRequestHostEvent, type IRetryEvent, type IShouldCloseConnEvent, type ISubmitChangesetEvent, type ITerminateEvent, type IUpdateCursorEvent, type IUserJoinEvent, type IUserLeaveEvent, type 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 { 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 { generateTempDocumentSnapshot, generateTemporarySnap, getSheetBlocksFromSnapshot, transformDocumentDataToSnapshot, transformSnapshotToDocumentData, transformSnapshotToWorkbookData, transformWorkbookDataToSnapshot } from './services/snapshot/snapshot-transform';
+export { textDecoder, textEncoder } from './services/snapshot/snapshot-utils';
+export { type IMutationTransformAlgorithm, ITransformService, makeArray, 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 { IHistoryIoService } from './services/history/type';
+export { type IRevertRevisionMutationParams, RevertRevisionMutation } from './command/revert-revision.mutation';
+export { CreateUnitMutation, type ICreateUnitMutationParams } from './command/create-unit.mutation';