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

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 _0x420d(){var _0x71a065=['CollaborationController','UNIVER_SHEET','198CZqKuD','defineProperty','exports','540acpCrJ','64830xEACZL','UniverProCollaborationClient','FBase','UniverInstanceType','waitForRoom$','subscribe','extend','get','UniverProCollaboration','Module','_injector','object','_snapshotService','IUniverInstanceService','124415TIzpAr','_univerInstanceService','rxjs','getCollaboration','_handler','getUniverSheet','toStringTag','SnapshotService','117986lQjbDa','4287rtJBIo','switchMap','1237398rqIKGy','values','from','@univerjs-pro/collaboration-client','244rpZoWy','686otvCMY','Injector','_collaborationController','476250jnCNjs','MemberService','FUniver','members$','@univerjs/core','Inject','UniverProCollaborationClientFacade','readyForCollab','5nuFcwp','createInstance','subscribeCollaborators','amd','loadActiveSheet','toDisposable','loadSheet','2232hsMnSX','getOwnPropertyDescriptor','@univerjs-pro/collaboration','[FCollaboration]:\x20this\x20method\x20should\x20be\x20override.','FCollaboration'];_0x420d=function(){return _0x71a065;};return _0x420d();}function _0x4b3f(_0x2b9cb9,_0x4b97c5){var _0x420d88=_0x420d();return _0x4b3f=function(_0x4b3f4b,_0x4be31c){_0x4b3f4b=_0x4b3f4b-0x10a;var _0x48e133=_0x420d88[_0x4b3f4b];return _0x48e133;},_0x4b3f(_0x2b9cb9,_0x4b97c5);}(function(_0x98a525,_0x2c0432){var _0x2b6839=_0x4b3f,_0x289b0=_0x98a525();while(!![]){try{var _0x19a6ae=-parseInt(_0x2b6839(0x127))/0x1+-parseInt(_0x2b6839(0x13a))/0x2+parseInt(_0x2b6839(0x130))/0x3*(-parseInt(_0x2b6839(0x136))/0x4)+parseInt(_0x2b6839(0x142))/0x5*(parseInt(_0x2b6839(0x132))/0x6)+parseInt(_0x2b6839(0x137))/0x7*(parseInt(_0x2b6839(0x10e))/0x8)+parseInt(_0x2b6839(0x115))/0x9*(-parseInt(_0x2b6839(0x119))/0xa)+-parseInt(_0x2b6839(0x12f))/0xb*(-parseInt(_0x2b6839(0x118))/0xc);if(_0x19a6ae===_0x2c0432)break;else _0x289b0['push'](_0x289b0['shift']());}catch(_0x21b4d9){_0x289b0['push'](_0x289b0['shift']());}}}(_0x420d,0x1e406),function(_0x1c4960,_0x16513c){var _0x1ad441=_0x4b3f;typeof exports==_0x1ad441(0x124)&&typeof module<'u'?_0x16513c(exports,require(_0x1ad441(0x13e)),require(_0x1ad441(0x110)),require(_0x1ad441(0x135)),require(_0x1ad441(0x129))):typeof define=='function'&&define[_0x1ad441(0x10a)]?define([_0x1ad441(0x117),_0x1ad441(0x13e),'@univerjs-pro/collaboration',_0x1ad441(0x135),_0x1ad441(0x129)],_0x16513c):(_0x1c4960=typeof globalThis<'u'?globalThis:_0x1c4960||self,_0x16513c(_0x1c4960[_0x1ad441(0x140)]={},_0x1c4960['UniverCore'],_0x1c4960[_0x1ad441(0x121)],_0x1c4960[_0x1ad441(0x11a)],_0x1c4960['rxjs']));}(this,function(_0x5014ba,_0x3081a7,_0x371984,_0x38c004,_0x3ac28c){'use strict';var _0x4442b2=_0x4b3f;var _0x50ef56=Object[_0x4442b2(0x116)],_0x4b8850=Object[_0x4442b2(0x10f)],_0x13cbf0=(_0x5ddce8,_0x4fe74a,_0x1cc046,_0x371c5a)=>{for(var _0x11eff7=_0x371c5a>0x1?void 0x0:_0x371c5a?_0x4b8850(_0x4fe74a,_0x1cc046):_0x4fe74a,_0x12d4e1=_0x5ddce8['length']-0x1,_0x33573e;_0x12d4e1>=0x0;_0x12d4e1--)(_0x33573e=_0x5ddce8[_0x12d4e1])&&(_0x11eff7=(_0x371c5a?_0x33573e(_0x4fe74a,_0x1cc046,_0x11eff7):_0x33573e(_0x11eff7))||_0x11eff7);return _0x371c5a&&_0x11eff7&&_0x50ef56(_0x4fe74a,_0x1cc046,_0x11eff7),_0x11eff7;},_0x13eac9=(_0x402fc4,_0x1d8276)=>(_0x187ab6,_0x383f8a)=>_0x1d8276(_0x187ab6,_0x383f8a,_0x402fc4);_0x5014ba[_0x4442b2(0x112)]=class extends _0x3081a7[_0x4442b2(0x11b)]{constructor(_0x54f848,_0x493a8,_0x367042,_0x3a80d7,_0x43d8bc){var _0x3a3d21=_0x4442b2;super(),this[_0x3a3d21(0x12b)]=_0x54f848,this[_0x3a3d21(0x123)]=_0x493a8,this[_0x3a3d21(0x128)]=_0x367042,this[_0x3a3d21(0x125)]=_0x3a80d7,this[_0x3a3d21(0x139)]=_0x43d8bc;}async[_0x4442b2(0x10b)](){var _0x51741f=_0x4442b2;throw new Error(_0x51741f(0x111));}async['loadSheet'](_0x418992){var _0x2a3a30=_0x4442b2;return this[_0x2a3a30(0x128)]['getUnit'](_0x418992,_0x3081a7[_0x2a3a30(0x11c)][_0x2a3a30(0x114)])||await this[_0x2a3a30(0x125)][_0x2a3a30(0x10d)](_0x418992,0x0)?(await this[_0x2a3a30(0x139)][_0x2a3a30(0x141)](_0x418992),this[_0x2a3a30(0x12b)]['getUniverSheet'](_0x418992)):null;}[_0x4442b2(0x144)](_0x4a5fe0,_0x29a520){var _0x205ff1=_0x4442b2;const _0x3a548a=this['_injector'][_0x205ff1(0x120)](_0x38c004[_0x205ff1(0x13b)])[_0x205ff1(0x11d)](_0x4a5fe0)['pipe'](_0x3ac28c[_0x205ff1(0x131)](_0x3222ac=>_0x3222ac[_0x205ff1(0x13d)]))[_0x205ff1(0x11e)](_0x78ae03=>_0x29a520(Array[_0x205ff1(0x134)](_0x78ae03[_0x205ff1(0x133)]())));return _0x3081a7[_0x205ff1(0x10c)](_0x3a548a);}},_0x5014ba[_0x4442b2(0x112)]=_0x13cbf0([_0x13eac9(0x1,_0x3081a7[_0x4442b2(0x13f)](_0x3081a7[_0x4442b2(0x138)])),_0x13eac9(0x2,_0x3081a7[_0x4442b2(0x126)]),_0x13eac9(0x3,_0x3081a7[_0x4442b2(0x13f)](_0x371984[_0x4442b2(0x12e)])),_0x13eac9(0x4,_0x3081a7['Inject'](_0x38c004[_0x4442b2(0x113)]))],_0x5014ba[_0x4442b2(0x112)]);class _0x302295 extends _0x3081a7[_0x4442b2(0x13c)]{[_0x4442b2(0x12a)](){var _0x847a53=_0x4442b2;return this[_0x847a53(0x123)][_0x847a53(0x143)](_0x5014ba[_0x847a53(0x112)],{'getUniverSheet':_0x98c72d=>this[_0x847a53(0x12c)](_0x98c72d)});}}_0x3081a7[_0x4442b2(0x13c)][_0x4442b2(0x11f)](_0x302295),Object[_0x4442b2(0x116)](_0x5014ba,Symbol[_0x4442b2(0x12d)],{'value':_0x4442b2(0x122)});}));