@univerjs-pro/collaboration-client 0.5.1 → 0.5.2-nightly.202412291605

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

@@ -1,9 +1,9 @@
-import { IDisposable, Nullable, IConfigService, ILogService, LocaleService, RxDisposable } from '@univerjs/core';
 import { ICollaborationEvent } from '@univerjs-pro/collaboration';
+import { IDisposable, Nullable, IConfigService, ILogService, LocaleService, RxDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { ICollaborationSocket } from '../socket/collaboration-socket.service';
 import { ITelemetryService } from '@univerjs/telemetry';
-import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
+import { CollaborationUIEventService } from '../collaboration-ui-event/collaboration-ui-event';
 import { CommentService } from '../comment/comment.service';
 import { MemberService } from '../member/member.service';
 export declare enum SessionStatus {
@@ -27,12 +27,11 @@ export declare const FailedReason: {
 export declare class CollaborationSession extends RxDisposable implements IDisposable {
     private readonly _unitID;
     private readonly _logService;
-    private readonly _beforeCloseService;
-    private readonly _messageService;
     private readonly _configService;
     private readonly _localeService;
     private readonly _memberService;
     private readonly _commentService;
+    private readonly _collaborationUIEventService;
     private readonly _telemetryService?;
     private readonly _sessionStatus$;
     readonly sessionStatus$: Observable<SessionStatus>;
@@ -41,7 +40,7 @@ export declare class CollaborationSession extends RxDisposable implements IDispo
     readonly event$: Observable<ICollaborationEvent>;
     private _socket;
     private _socketMessageSubscription;
-    constructor(_unitID: string, socket$: Observable<Nullable<ICollaborationSocket>>, _logService: ILogService, _beforeCloseService: IBeforeCloseService, _messageService: IMessageService, _configService: IConfigService, _localeService: LocaleService, _memberService: MemberService, _commentService: CommentService, _telemetryService?: ITelemetryService | undefined);
+    constructor(_unitID: string, socket$: Observable<Nullable<ICollaborationSocket>>, _logService: ILogService, _configService: IConfigService, _localeService: LocaleService, _memberService: MemberService, _commentService: CommentService, _collaborationUIEventService: CollaborationUIEventService, _telemetryService?: ITelemetryService | undefined);
     getMemberID(): string | null;
     dispose(): void;
     close(): void;

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

@@ -1,7 +1,8 @@
-import { Nullable, Disposable, IConfigService, ILogService, Injector, LocaleService } from '@univerjs/core';
+import { Nullable, Disposable, IConfigService, ILogService, Injector } from '@univerjs/core';
 import { ICollaborationSocket, ICollaborationSocketService } from '../socket/collaboration-socket.service';
 import { HTTPService } from '@univerjs/network';
-import { IMessageService } from '@univerjs/ui';
+import { CollaborationUIEventService } from '../collaboration-ui-event/collaboration-ui-event';
+import { INetworkConditionService } from '../network-condition/network-condition.service';
 import { CollaborationSession, SessionStatus } from './collaboration-session';
 /**
  * This service provide collaboration sessions to univer instances. A collaboration session
@@ -9,12 +10,12 @@ import { CollaborationSession, SessionStatus } from './collaboration-session';
  */
 export declare class CollaborationSessionService extends Disposable {
     private readonly _injector;
-    private readonly _localeService;
-    private readonly _messageService;
     private readonly _logService;
     private readonly _configService;
     private readonly _socketService;
     private readonly _httpService;
+    private readonly _collaborationUIEventService;
+    private readonly _networkConditionService?;
     /**
      * Socket for collaboration sessions. Session are by unitID but the socket is share by collaboration sessions.
      */
@@ -28,8 +29,8 @@ export declare class CollaborationSessionService extends Disposable {
     private _socketReady;
     private _retryConnectingTimer;
     private _retryCount;
-    constructor(_injector: Injector, _localeService: LocaleService, _messageService: IMessageService, _logService: ILogService, _configService: IConfigService, _socketService: ICollaborationSocketService, _httpService: HTTPService);
-    private _initEventListeners;
+    constructor(_injector: Injector, _logService: ILogService, _configService: IConfigService, _socketService: ICollaborationSocketService, _httpService: HTTPService, _collaborationUIEventService: CollaborationUIEventService, _networkConditionService?: INetworkConditionService | undefined);
+    private _listenToNetworkCondition;
     dispose(): void;
     /**
      * Require a collaboration session.
@@ -59,10 +60,8 @@ export declare class CollaborationSessionService extends Disposable {
      */
     private _tryEnsureSocket;
     private _onConnectionOpen;
-    private _listenToOfflineEvent;
     private _onOffline;
     private _onConnectionFailed;
-    private _listenToOnlineEvent;
     private _tryReconnect;
     private _onMessage;
     private _sendHeartbeatTimer;

package/lib/types/services/collaboration-ui-event/collaboration-ui-event.d.ts

@@ -0,0 +1,19 @@
+export interface ICollaborationUIEvent {
+    id: CollaborationUIEventId;
+    data?: string;
+}
+export declare enum CollaborationUIEventId {
+    OTHER_CLIENT_EDITING = "OTHER_CLIENT_EDITING",
+    PERMISSION_DENIED = "PERMISSION_DENIED",
+    CONFLICT = "CONFLICT",
+    CLOSE_ROOM = "CLOSE_ROOM",
+    JOIN_ROOM_FAILED = "JOIN_ROOM_FAILED",
+    SOCKET_FAILED_RETRY = "SOCKET_FAILED_RETRY",
+    SOCKET_FAILED = "SOCKET_FAILED",
+    SUBMIT_CHANGESET_TIMEOUT = "SUBMIT_CHANGESET_TIMEOUT"
+}
+export declare class CollaborationUIEventService {
+    private readonly _event$;
+    readonly event$: import('rxjs').Observable<ICollaborationUIEvent>;
+    emitEvent(event: ICollaborationUIEvent): void;
+}

package/lib/types/services/data-loader/data-loader.service.d.ts

@@ -0,0 +1,23 @@
+import { UnitModel, ILogService, RxDisposable } from '@univerjs/core';
+import { SnapshotService } from '@univerjs-pro/collaboration';
+import { UniverType } from '@univerjs/protocol';
+import { ILocalCacheService } from '../local-cache/local-cache.service';
+export interface IUnitInfo {
+    unitId: string;
+    type: UniverType;
+    subUnitId?: string;
+}
+/**
+ * This service provides a way to load data from the server and initialize the Univer instance.
+ */
+export declare class DataLoaderService extends RxDisposable {
+    private readonly _logService;
+    private readonly _snapshotService;
+    private readonly _localCacheService?;
+    private readonly _unitInfo$;
+    readonly unitInfo$: import('rxjs').Observable<IUnitInfo | null>;
+    constructor(_logService: ILogService, _snapshotService: SnapshotService, _localCacheService?: ILocalCacheService | undefined);
+    loadUnit(unitId: string, type: UniverType, subUnitId?: string): Promise<UnitModel | null>;
+    private _loadSheet;
+    private _loadDoc;
+}

package/lib/types/services/image-remote/image-io.service.d.ts

@@ -12,7 +12,7 @@ export interface ISignUrlResponse {
     error: IError | undefined;
     url: string;
 }
-export declare class CollabrationImageIoService implements IImageIoService {
+export declare class CollaborationImageIoService implements IImageIoService {
     private readonly _httpService;
     private readonly _configService;
     private readonly _univerInstanceService;

package/lib/types/services/local-cache/local-cache.service.d.ts

@@ -1,7 +1,6 @@
-import { IMutationInfo, Nullable, Disposable, IConfigService, ILocalStorageService, LocaleService } from '@univerjs/core';
+import { IMutationInfo, Nullable } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
-import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
-import { IBeforeCloseService } from '@univerjs/ui';
+import { IChangeset } from '@univerjs-pro/collaboration';
 export interface IUnitCacheData {
     unitID: string;
     type: UniverType;
@@ -9,29 +8,14 @@ export interface IUnitCacheData {
     awaitingChangeset: Nullable<IChangeset>;
     mutations: IMutationInfo[];
 }
-/**
- * This service provide caching to the collaboration controller.
- */
-export declare class LocalCacheService extends Disposable {
-    private readonly _configService;
-    private readonly _localStorageService;
-    private readonly _beforeCloseService;
-    private readonly _localeService;
-    private readonly _revisionService;
-    private _cachedData;
-    private _saveTaskMap;
-    private _disabled;
-    constructor(_configService: IConfigService, _localStorageService: ILocalStorageService, _beforeCloseService: IBeforeCloseService, _localeService: LocaleService, _revisionService: RevisionService);
-    disableLocalCache(): void;
-    enableLocalCache(): void;
-    dispose(): void;
+export interface ILocalCacheService {
     loadOfflineData(unitID: string): Promise<Nullable<IUnitCacheData>>;
     saveOfflineData(unitID: string, data: IUnitCacheData): Promise<boolean>;
     updateOfflineData(unitID: string, type: UniverType, awaitingChangeset: Nullable<IChangeset>, pendingMutations: IMutationInfo[]): void;
-    private _scheduleSaving;
-    private _getSaveTimeout;
-    private _saveCache;
+    disableLocalCache(): void;
+    enableLocalCache(): void;
     exhaustSavingTask(): Promise<void>;
-    private _setupBeforeClosingHandler;
+    saveTaskMap: Map<string, number>;
 }
+export declare const ILocalCacheService: import('@wendellhu/redi').IdentifierDecorator<ILocalCacheService>;
 export declare function getLocalCacheKey(unitID: string): string;

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

@@ -1,5 +1,6 @@
 import { Nullable, Disposable, IUniverInstanceService, UserManagerService } from '@univerjs/core';
 import { IMember } from '@univerjs/protocol';
+import { Observable } from 'rxjs';
 export interface IUser extends IMember {
     userID: string;
 }
@@ -10,7 +11,9 @@ export declare class MemberService extends Disposable {
     private readonly _univerInstanceService;
     private _userManagerService;
     private _roomMembers;
+    private readonly _roomCreated$;
     constructor(_univerInstanceService: IUniverInstanceService, _userManagerService: UserManagerService);
+    waitForRoom$(unitId: string): Observable<RoomMember>;
     /**
      * @deprecated please use userManagerService
      */
@@ -52,6 +55,8 @@ export declare class MemberService extends Disposable {
  */
 export declare class RoomMember extends Disposable {
     private readonly _members;
+    private readonly _members$;
+    readonly members$: Observable<Map<string, IMember>>;
     dispose(): void;
     /**
      * Update a member in the room(unit).
@@ -74,4 +79,5 @@ export declare class RoomMember extends Disposable {
      * @returns member object array.
      */
     getAllMembers(): IMember[];
+    private _emitMembers;
 }

package/lib/types/services/network-condition/network-condition.service.d.ts

@@ -0,0 +1,6 @@
+import { Observable } from 'rxjs';
+export interface INetworkConditionService {
+    online$: Observable<boolean>;
+    online: boolean;
+}
+export declare const INetworkConditionService: import('@wendellhu/redi').IdentifierDecorator<INetworkConditionService>;

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

@@ -1,12 +1,17 @@
-import { Injector, IPermissionService, IUniverInstanceService, LocaleService, RxDisposable } from '@univerjs/core';
+import { IAuthzIoService, Injector, IPermissionService, IUndoRedoService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
 import { CollaborationSessionService } from '../collaboration-session/collaboration-session.service';
+import { CollaborationUIEventService } from '../collaboration-ui-event/collaboration-ui-event';
 export declare class PermissionService extends RxDisposable {
     private _injector;
     private _univerInstanceService;
     private _permissionService;
     private _collaborationSessionService;
-    private _localeService;
-    constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _collaborationSessionService: CollaborationSessionService, _localeService: LocaleService);
+    private _collaborationUIEventService;
+    private _authzIoService;
+    private readonly _undoRedoService;
+    constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _collaborationSessionService: CollaborationSessionService, _collaborationUIEventService: CollaborationUIEventService, _authzIoService: IAuthzIoService, _undoRedoService: IUndoRedoService);
     private _initCloseConn;
     private _initUnitPermissionChange;
+    initWorkbookPermissionChange(_unitId?: string): Promise<void>;
+    refreshPermission(unitId: string, permissionId: string): void;
 }

package/lib/types/services/single-active-unit/single-active-unit.service.d.ts

@@ -1,4 +1,3 @@
-import { Disposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 /**
  * It is not recommended to open multiple units in different browser tabs at the same time,
@@ -14,26 +13,3 @@ export declare enum UnitStatus {
     NO_OTHER_CLIENTS_EDITING = 0,
     OTHER_CLIENTS_EDITING = 1
 }
-export declare class WebBrowserSingleActiveUnitService extends Disposable implements ISingleActiveUnitService {
-    private _id;
-    private _selfUnitIDs;
-    private _unitOnClients;
-    private _heartbeatTimer;
-    private _clearOtherTimers;
-    private _unitStatus;
-    constructor();
-    dispose(): void;
-    getUnitStatus$(unitID: string): Observable<UnitStatus>;
-    editingUnit(unitID: string): void;
-    disposeUnit(unitID: string): void;
-    private _init;
-    private _handleEvent;
-    private _handleJoinEvent;
-    private _scheduleClearOtherTimer;
-    private _removeClearOtherTimer;
-    private _handleLeaveEvent;
-    private _handleHeartbeatEvent;
-    private _send;
-    private _scheduleHeartbeat;
-    private _ensureSubject;
-}

package/lib/types/services/socket/collaboration-socket.service.d.ts

@@ -1,6 +1,6 @@
 import { ICombRequestEvent, ICombResponseEvent, IFetchingMissEvent, ISubmitChangesetEvent, ISnapshotServerService } from '@univerjs-pro/collaboration';
-import { Nullable, Disposable, IConfigService, ILogService } from '@univerjs/core';
-import { ISocket, HTTPService, WebSocketService } from '@univerjs/network';
+import { Nullable, Disposable, IConfigService, ILogService, Injector } from '@univerjs/core';
+import { ISocket, HTTPService } from '@univerjs/network';
 import { IChangeset } from '@univerjs/protocol';
 import { Observable } from 'rxjs';
 export interface ICollaborationSocket extends Pick<ISocket, 'open$' | 'error$' | 'close$'> {
@@ -17,12 +17,12 @@ export interface ICollaborationSocketService {
 }
 export declare const ICollaborationSocketService: import('@wendellhu/redi').IdentifierDecorator<ICollaborationSocketService>;
 export declare class CollaborationSocketService extends Disposable implements ICollaborationSocketService {
+    protected readonly _injector: Injector;
     protected readonly _http: HTTPService;
-    protected readonly _ws: WebSocketService;
     protected readonly _configService: IConfigService;
     protected readonly _logService: ILogService;
     protected readonly _snapshotServerService: ISnapshotServerService;
-    constructor(_http: HTTPService, _ws: WebSocketService, _configService: IConfigService, _logService: ILogService, _snapshotServerService: ISnapshotServerService);
+    constructor(_injector: Injector, _http: HTTPService, _configService: IConfigService, _logService: ILogService, _snapshotServerService: ISnapshotServerService);
     /**
      * Create a socket that would connect to the remote collaboration server. It would throw an error when the socket cannot be created.
      *

package/lib/umd/facade.js

@@ -0,0 +1 @@
+function _0x2ef6(_0x2d1c46,_0x2f81f8){var _0x385a90=_0x385a();return _0x2ef6=function(_0x2ef67f,_0x33a70f){_0x2ef67f=_0x2ef67f-0x9b;var _0x5ec20e=_0x385a90[_0x2ef67f];return _0x5ec20e;},_0x2ef6(_0x2d1c46,_0x2f81f8);}function _0x385a(){var _0x5d575b=['values','createInstance','from','subscribe','828049HoCbYz','rxjs','2031462NvFSoF','2886804OqTiOq','toStringTag','waitForRoom$','FBase','getCollaboration','UniverProCollaborationClient','object','15qeJlFi','@univerjs/core','UNIVER_SHEET','members$','140HzAFmG','_injector','loadActiveSheet','Inject','UniverCore','_snapshotService','extend','defineProperty','353128lLWBfH','@univerjs-pro/collaboration','SnapshotService','toDisposable','[FCollaboration]:\x20this\x20method\x20should\x20be\x20override.','UniverProCollaboration','amd','UniverProCollaborationClientFacade','3758166CNptHR','CollaborationController','switchMap','readyForCollab','getUnit','getOwnPropertyDescriptor','getUniverSheet','Module','FUniver','FCollaboration','subscribeCollaborators','_univerInstanceService','loadSheet','exports','_collaborationController','@univerjs-pro/collaboration-client','796208aORGKh','length','1350736aeToXO','get'];_0x385a=function(){return _0x5d575b;};return _0x385a();}(function(_0x3fd3f4,_0x3c8ce8){var _0x200053=_0x2ef6,_0x5b9bf1=_0x3fd3f4();while(!![]){try{var _0x33ab7c=parseInt(_0x200053(0x9b))/0x1+parseInt(_0x200053(0xcb))/0x2+-parseInt(_0x200053(0x9d))/0x3+parseInt(_0x200053(0xc9))/0x4*(parseInt(_0x200053(0xa5))/0x5)+-parseInt(_0x200053(0x9e))/0x6+-parseInt(_0x200053(0xa9))/0x7*(parseInt(_0x200053(0xb1))/0x8)+parseInt(_0x200053(0xb9))/0x9;if(_0x33ab7c===_0x3c8ce8)break;else _0x5b9bf1['push'](_0x5b9bf1['shift']());}catch(_0x2f883a){_0x5b9bf1['push'](_0x5b9bf1['shift']());}}}(_0x385a,0x7476f),function(_0x506b52,_0x44b5e4){var _0x5cd5e2=_0x2ef6;typeof exports==_0x5cd5e2(0xa4)&&typeof module<'u'?_0x44b5e4(exports,require(_0x5cd5e2(0xa6)),require(_0x5cd5e2(0xb2)),require(_0x5cd5e2(0xc8)),require(_0x5cd5e2(0x9c))):typeof define=='function'&&define[_0x5cd5e2(0xb7)]?define([_0x5cd5e2(0xc6),_0x5cd5e2(0xa6),'@univerjs-pro/collaboration',_0x5cd5e2(0xc8),_0x5cd5e2(0x9c)],_0x44b5e4):(_0x506b52=typeof globalThis<'u'?globalThis:_0x506b52||self,_0x44b5e4(_0x506b52[_0x5cd5e2(0xb8)]={},_0x506b52[_0x5cd5e2(0xad)],_0x506b52[_0x5cd5e2(0xb6)],_0x506b52[_0x5cd5e2(0xa3)],_0x506b52[_0x5cd5e2(0x9c)]));}(this,function(_0x21afb2,_0x313eae,_0x4dc5f2,_0x351b43,_0x4276de){'use strict';var _0x372ec3=_0x2ef6;var _0x1a0344=Object[_0x372ec3(0xb0)],_0x5f5b3a=Object[_0x372ec3(0xbe)],_0x1b9ac1=(_0x5f2ae4,_0x3979d6,_0x94e900,_0x5312fa)=>{var _0x1c0a30=_0x372ec3;for(var _0x5a4987=_0x5312fa>0x1?void 0x0:_0x5312fa?_0x5f5b3a(_0x3979d6,_0x94e900):_0x3979d6,_0x20947c=_0x5f2ae4[_0x1c0a30(0xca)]-0x1,_0x40e475;_0x20947c>=0x0;_0x20947c--)(_0x40e475=_0x5f2ae4[_0x20947c])&&(_0x5a4987=(_0x5312fa?_0x40e475(_0x3979d6,_0x94e900,_0x5a4987):_0x40e475(_0x5a4987))||_0x5a4987);return _0x5312fa&&_0x5a4987&&_0x1a0344(_0x3979d6,_0x94e900,_0x5a4987),_0x5a4987;},_0xd4897d=(_0x472caa,_0x53b839)=>(_0x10ed06,_0x38a0fd)=>_0x53b839(_0x10ed06,_0x38a0fd,_0x472caa);_0x21afb2[_0x372ec3(0xc2)]=class extends _0x313eae[_0x372ec3(0xa1)]{constructor(_0x413987,_0x442a38,_0x33e0fb,_0x5f2b10,_0x5a4b14){var _0x1d8692=_0x372ec3;super(),this['_handler']=_0x413987,this[_0x1d8692(0xaa)]=_0x442a38,this['_univerInstanceService']=_0x33e0fb,this[_0x1d8692(0xae)]=_0x5f2b10,this['_collaborationController']=_0x5a4b14;}async[_0x372ec3(0xab)](){var _0xff65f7=_0x372ec3;throw new Error(_0xff65f7(0xb5));}async[_0x372ec3(0xc5)](_0x5d1d8c){var _0x45f228=_0x372ec3;return this[_0x45f228(0xc4)][_0x45f228(0xbd)](_0x5d1d8c,_0x313eae['UniverInstanceType'][_0x45f228(0xa7)])||await this['_snapshotService'][_0x45f228(0xc5)](_0x5d1d8c,0x0)?(await this[_0x45f228(0xc7)][_0x45f228(0xbc)](_0x5d1d8c),this['_handler'][_0x45f228(0xbf)](_0x5d1d8c)):null;}[_0x372ec3(0xc3)](_0xcffad,_0x4e7774){var _0xf71ed7=_0x372ec3;const _0xd70d33=this[_0xf71ed7(0xaa)][_0xf71ed7(0xcc)](_0x351b43['MemberService'])[_0xf71ed7(0xa0)](_0xcffad)['pipe'](_0x4276de[_0xf71ed7(0xbb)](_0xba4b24=>_0xba4b24[_0xf71ed7(0xa8)]))[_0xf71ed7(0xd0)](_0x356946=>_0x4e7774(Array[_0xf71ed7(0xcf)](_0x356946[_0xf71ed7(0xcd)]())));return _0x313eae[_0xf71ed7(0xb4)](_0xd70d33);}},_0x21afb2['FCollaboration']=_0x1b9ac1([_0xd4897d(0x1,_0x313eae[_0x372ec3(0xac)](_0x313eae['Injector'])),_0xd4897d(0x2,_0x313eae['IUniverInstanceService']),_0xd4897d(0x3,_0x313eae[_0x372ec3(0xac)](_0x4dc5f2[_0x372ec3(0xb3)])),_0xd4897d(0x4,_0x313eae[_0x372ec3(0xac)](_0x351b43[_0x372ec3(0xba)]))],_0x21afb2[_0x372ec3(0xc2)]);class _0x4392a5 extends _0x313eae[_0x372ec3(0xc1)]{[_0x372ec3(0xa2)](){var _0x172879=_0x372ec3;return this['_injector'][_0x172879(0xce)](_0x21afb2[_0x172879(0xc2)],{'getUniverSheet':_0x1aec9b=>this['getUniverSheet'](_0x1aec9b)});}}_0x313eae[_0x372ec3(0xc1)][_0x372ec3(0xaf)](_0x4392a5),Object[_0x372ec3(0xb0)](_0x21afb2,Symbol[_0x372ec3(0x9f)],{'value':_0x372ec3(0xc0)});}));