@univerjs-pro/collaboration-client 0.4.1 → 0.4.2

package/lib/types/controllers/collaboration/collaboration-entity.d.ts

@@ -1,7 +1,6 @@
-import { IDisposable, IMutationInfo, ICommandService, ILogService, Injector, IPermissionService, LocaleService, RxDisposable } from '@univerjs/core';
+import { IDisposable, IMutationInfo, Nullable, ICommandService, ILogService, Injector, IPermissionService, LocaleService, RxDisposable } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
 import { Observable, BehaviorSubject } from 'rxjs';
-import { Nullable } from 'vitest';
 import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
 import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
 import { DocStateChangeManagerService } from '@univerjs/docs-ui';
@@ -11,6 +10,7 @@ import { DocTransformIMECacheService } from '../../services/ime-cache-transform/
 import { LocalCacheService } from '../../services/local-cache/local-cache.service';
 import { SheetTransformSelectionsService } from '../../services/range-selection/sheet-transform-selections.service';
 import { ISingleActiveUnitService } from '../../services/single-active-unit/single-active-unit.service';
+import { DocTransformStateCacheService } from '../../services/state-cache-transform/doc-transform-state-cache.service';
 import { DocSyncEditingCollabCursorService } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 import { DocTransformSelectionsService } from '../../services/text-selection/doc-transform-selections.service';
 /**
@@ -60,6 +60,7 @@ export declare abstract class CollaborationEntity extends RxDisposable {
     private _applyRemoteChangeset;
     private _onRemoteACK;
     private _onRemoteRejected;
+    private _onRemoteRetry;
     private _onFetchMissResult;
     private _toggleOffline;
     private _toggleOnline;
@@ -73,9 +74,10 @@ export declare class DocCollaborationEntity extends CollaborationEntity {
     readonly type: UniverType;
     private readonly _docStateChangeManagerService;
     private readonly _docTransformIMECacheService;
+    private readonly _docTransformStateCacheService;
     private readonly _docTransformSelectionsService;
     private readonly _docSyncEditingCollabCursorService;
-    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _docStateChangeManagerService: DocStateChangeManagerService, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, permissionService: IPermissionService, singleActiveUnitService?: ISingleActiveUnitService);
+    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _docStateChangeManagerService: DocStateChangeManagerService, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformStateCacheService: DocTransformStateCacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, permissionService: IPermissionService, singleActiveUnitService?: ISingleActiveUnitService);
     protected _createHandler(): ICollaborationStateHandler;
     protected _init(): Promise<CollaborationState>;
 }

package/lib/types/controllers/collaboration/collaboration-state.d.ts

@@ -1,5 +1,6 @@
 import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, Injector, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
+import { Observable } from 'rxjs';
 import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
 import { UniverType } from '@univerjs/protocol';
@@ -16,16 +17,20 @@ export type MissingChangesetsHandler = (params: {
 }) => void;
 export type TransformSelectionsHandler = (changeset: IChangeset) => void;
 export type TransformIMEHandler = (changeset: IChangeset) => void;
+export type TransformStateHandler = (changeset: IChangeset) => void;
 export type SyncEditingCollabCursorHandler = (params: ICollabEditingCursor) => void;
 export type TransformRemoteChangesetByIMECache = (changeset: IChangeset) => IChangeset;
+export type TransformRemoteChangesetByStateCache = (changeset: IChangeset) => IChangeset;
 export interface ICollaborationStateHandler {
     onStateChange: StateChangeHandler;
     onSendChangeset: SendChangesetHandler;
     onMissingChangesets: MissingChangesetsHandler;
     onTransformSelections?: TransformSelectionsHandler;
     onTransformIME?: TransformIMEHandler;
+    onTransformState?: TransformStateHandler;
     onSyncEditingCollabCursor?: SyncEditingCollabCursorHandler;
     onTransformRemoteChangesetByIMECache?: TransformRemoteChangesetByIMECache;
+    onTransformRemoteChangesetByStateCache?: TransformRemoteChangesetByStateCache;
 }
 export declare enum CollaborationStatus {
     NOT_COLLAB = "not_collab",
@@ -80,6 +85,10 @@ export declare abstract class CollaborationState {
     abstract onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    /**
+     * Received a retry message from the server, meaning that some unexpected error occurred in server.
+     */
+    abstract onRemoteRetry(changeset: IChangeset): CollaborationState;
     abstract toggleOffline(): CollaborationState;
     abstract toggleOnline(): CollaborationState;
     /**
@@ -95,7 +104,9 @@ export declare abstract class CollaborationState {
     /** Transform selections by calling the selection manager service. */
     protected _transformSelections(changeset: IChangeset): void;
     protected _transformIMECache(changeset: IChangeset): void | undefined;
+    protected _transformStateCache(changeset: IChangeset): void | undefined;
     protected _transformRemoteChangesetByIMECache(changeset: IChangeset): IChangeset;
+    protected _transformRemoteChangesetByStateCache(changeset: IChangeset): IChangeset;
     protected _syncEditingCollabCursor(changeset: IChangeset): void;
     /** @internal */
     _updateLocalCache(): void;
@@ -117,6 +128,7 @@ export declare class SyncedState extends CollaborationState {
     private _onConflict;
     onRemoteAck(): never;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -142,6 +154,7 @@ export declare class PendingState extends CollaborationState {
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     /**
@@ -163,6 +176,9 @@ export declare class AwaitingState extends CollaborationState {
     private readonly _logService;
     private readonly _transformService;
     readonly status = CollaborationStatus.AWAITING;
+    private _resendTimeout;
+    private _resendTimer;
+    private _sender;
     constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, handler: ICollaborationStateHandler, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
@@ -170,10 +186,13 @@ export declare class AwaitingState extends CollaborationState {
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(changeset: IChangeset): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
     private _onConflict;
+    private _resendWithTimeout;
+    private _clearScheduledTask;
 }
 /**
  * Some local mutations are sent to the server and waiting for acknowledgement, yet still some local mutations
@@ -184,17 +203,26 @@ export declare class AwaitingWithPendingState extends CollaborationState {
     private readonly _logService;
     private readonly _transformService;
     readonly status = CollaborationStatus.AWAITING_WITH_PENDING;
-    constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
+    private _resendTimeout;
+    private _resendTimer;
+    private _sender;
+    constructor(unitID: string, type: UniverType, awaitingChangeset: IChangeset, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, timer: Observable<{
+        timeout: number;
+        reqId: number;
+    }> | undefined, _injector: Injector, revisionService: RevisionService, localCacheService: LocalCacheService, commandService: ICommandService, _logService: ILogService, _transformService: ITransformService, undoRedoService: ICollaborativeUndoRedoService);
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(changeset: IAcknowledgedChangeset): CollaborationState;
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(changeset: IChangeset): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
     private _onConflict;
+    private _resendWithTimeout;
+    private _clearScheduledTask;
 }
 /**
  * This state is special for handling collaboration conflicts.
@@ -213,6 +241,7 @@ export declare class ConflictState extends CollaborationState {
     onRemoteChangeset(): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -228,6 +257,7 @@ export declare class OfflineState extends CollaborationState {
     onRemoteChangeset(_changeset: IChangeset): CollaborationState;
     onRemoteAck(): CollaborationState;
     onRemoteRej(): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -265,6 +295,7 @@ export declare class FetchingMissState extends CollaborationState {
     onRemoteRej(config?: {
         isPermissionRej: boolean;
     }): CollaborationState;
+    onRemoteRetry(): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     private _onConflict;

package/lib/types/controllers/collaboration/utils/changeset-utils.d.ts

@@ -1,5 +1,6 @@
 import { IMutationInfo, IUniverInstanceService } from '@univerjs/core';
 import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
+import { Observable } from 'rxjs';
 import { MemberService } from '../../../services/member/member.service';
 export interface IAssembledChangeset {
     changeset: IChangeset;
@@ -14,3 +15,4 @@ export declare const SINGLE_CHANGESET_MUTATIONS: Set<string>;
  */
 export declare function assembleSheetChangeset(pendingMutations: IMutationInfo[], unitID: string, univerInstanceService: IUniverInstanceService, revisionService: RevisionService, memberService: MemberService): IAssembledChangeset;
 export declare function assembleDocChangeset(pendingMutations: IMutationInfo[], unitID: string, univerInstanceService: IUniverInstanceService, revisionService: RevisionService, memberService: MemberService): IAssembledChangeset;
+export declare function createTimerObservable$<T>(ms: number, options: T): Observable<T>;

package/lib/types/index.d.ts

@@ -31,3 +31,4 @@ export { SnapshotServerOverHTTPService } from './services/snapshot-server/snapsh
 export { CommentService } from './services/comment/comment.service';
 export { type ISheetCollabCursorShapeProps, SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';
 export { ImageIoService } from './services/image-remote/image-io.service';
+export { MemberService } from './services/member/member.service';

package/lib/types/plugin.d.ts

@@ -14,5 +14,5 @@ export declare class UniverCollaborationClientPlugin extends Plugin {
     onRendered(): void;
     private _registerDependencies;
     private _registerRenderDependencies;
-    private _initModules;
+    private _initDependencies;
 }

package/lib/types/services/auth-server/util.d.ts

@@ -0,0 +1 @@
+export declare function getAttachHeader(): string | undefined;

package/lib/types/services/collaboration-session/collaboration-session.d.ts

@@ -1,11 +1,11 @@
-import { IConfigService, ILogService, LocaleService, RxDisposable, IDisposable, Nullable } from '@univerjs/core';
-import { ITelemetryService } from '@univerjs/telemetry';
-import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
+import { IDisposable, Nullable, IConfigService, ILogService, LocaleService, RxDisposable } from '@univerjs/core';
 import { ICollaborationEvent } from '@univerjs-pro/collaboration';
 import { Observable } from 'rxjs';
+import { ICollaborationSocket } from '../socket/collaboration-socket.service';
+import { ITelemetryService } from '@univerjs/telemetry';
+import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
 import { CommentService } from '../comment/comment.service';
 import { MemberService } from '../member/member.service';
-import { ICollaborationSocket } from '../socket/collaboration-socket.service';
 export declare enum SessionStatus {
     IDLE = 0,
     JOINING = 1,

package/lib/types/services/ime-cache-transform/doc-transform-ime-cache.service.d.ts

@@ -1,4 +1,4 @@
-import { ITransformService, IChangeset } from '@univerjs-pro/collaboration';
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 import { Injector } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
 export declare class DocTransformIMECacheService {

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

@@ -19,9 +19,30 @@ export declare class MemberService extends Disposable {
      * @deprecated please use userManagerService
      */
     getCurrentUser(): Nullable<IUser>;
+    /**
+     * Update a member in a room(unit).
+     * @param roomID i.e. unitID.
+     * @param member member object to be updated.
+     */
     updateMember(roomID: string, member: IMember): void;
+    /**
+     * Remove a member from a room(unit).
+     * @param roomID i.e. unitID.
+     * @param memberID memberID of the member to be removed.
+     */
     removeMember(roomID: string, memberID: string): void;
+    /**
+     * Get RoomMember for a unit.
+     * @param roomID which is same with unitId.
+     * @returns RoomMember which is a object that manages members in a single room.
+     */
     getRoom(roomID: string): RoomMember | undefined;
+    /**
+     * Get a member in a room(unit).
+     * @param roomID i.e. unitID.
+     * @param memberID memberID of the member to be retrieved.
+     * @returns member object.
+     */
     getMember(roomID: string, memberID: string): IMember | undefined;
     private _removeRoom;
     dispose(): void;
@@ -32,7 +53,25 @@ export declare class MemberService extends Disposable {
 export declare class RoomMember extends Disposable {
     private readonly _members;
     dispose(): void;
+    /**
+     * Update a member in the room(unit).
+     * @param member member object to be updated.
+     */
     updateMember(member: IMember): void;
+    /**
+     * Remove a member from the room(unit).
+     * @param memberID memberID of the member to be removed.
+     */
     removeMember(memberID: string): void;
+    /**
+     * Get a member by memberID.
+     * @param memberID
+     * @returns member object.
+     */
     getMember(memberID: string): IMember | undefined;
+    /**
+     * Get all members in the room(unit).
+     * @returns member object array.
+     */
+    getAllMembers(): IMember[];
 }

package/lib/types/services/state-cache-transform/doc-transform-state-cache.service.d.ts

@@ -0,0 +1,12 @@
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
+import { Injector } from '@univerjs/core';
+import { DocStateChangeManagerService } from '@univerjs/docs-ui';
+export declare class DocTransformStateCacheService {
+    private readonly _injector;
+    private readonly _transformService;
+    private readonly _docStateChangeManagerService;
+    constructor(_injector: Injector, _transformService: ITransformService, _docStateChangeManagerService: DocStateChangeManagerService);
+    transformStateCache(changeset: IChangeset): void;
+    transformRemoteChangeset(changeset: IChangeset): IChangeset;
+    private _transformHistoryAndStateStack;
+}

package/lib/types/services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service.d.ts

@@ -1,6 +1,6 @@
-import { IUpdateCursor } from '@univerjs/protocol';
 import { Nullable, RxDisposable } from '@univerjs/core';
 import { ITextRangeWithStyle } from '@univerjs/engine-render';
+import { IUpdateCursor } from '@univerjs/protocol';
 export interface ICollabEditingCursor {
     unitID: string;
     memberID: string;

package/lib/types/services/text-selection/doc-transform-selections.service.d.ts

@@ -1,5 +1,5 @@
-import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 import { Injector } from '@univerjs/core';
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 export declare class DocTransformSelectionsService {
     private readonly _injector;
     private readonly _transformService;