@univerjs-pro/collaboration-client 0.1.13 → 0.1.15

package/lib/types/config/config.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The config key to determined the URL provided by the snapshot server
+ * to load snapshot. The URL should not ends with a slash.
+ */
+export declare const SNAPSHOT_SERVER_URL_KEY = "SNAPSHOT_SERVER_URL_KEY";
+/**
+ * Default value for `SNAPSHOT_SERVER_URL_KEY`.
+ *
+ * Determined in the protocol file in `submodules/protocol/universer/v1/snapshot.proto`.
+ */
+export declare const DEFAULT_SNAPSHOT_SERVER_URL = "/universer-api/snapshot";
+/**
+ * @ignore
+ */
+export declare const SNAPSHOT_URL_KEY = "SNAPSHOT_URL_KEY";
+/**
+ * Determines how often should we send changesets.
+ */
+export declare const SEND_CHANGESET_TIMEOUT_KEY = "SEND_CHANGESET_TIMEOUT";
+export declare const DEFAULT_SEND_CHANGESET_TIMEOUT = 2000;
+export declare const COLLAB_WEB_SOCKET_URL_KEY = "COLLAB_WEB_SOCKET_URL";
+export declare const DEFAULT_COLLAB_WEB_SOCKET_URL = "ws://127.0.0.1:8000/universer-api/comb/connect";
+/** The heartbeat interval in milliseconds. */
+export declare const HEARTBEAT_INTERVAL_KEY = "HEARTBEAT_INTERVAL";
+export declare const DEFAULT_HEARTBEAT_INTERVAL = 30000;
+export declare const HEARTBEAT_TIMEOUT_KEY = "HEARTBEAT_TIMEOUT";
+export declare const DEFAULT_HEARTBEAT_TIMEOUT = 10000;
+export declare const RETRY_CONNECTING_INTERVAL_KEY = "RETRY_CONNECTING_INTERVAL";
+export declare const DEFAULT_RETRY_CONNECTING_INTERVAL = 20000;
+export declare const RETRY_CONNECTING_MAX_COUNT_KEY = "RETRY_CONNECTING_MAX_COUNT";
+export declare const DEFAULT_RETRY_CONNECTING_MAX_COUNT = 3;
+/**
+ * A config key to determine how often should Univer save local edits.
+ */
+export declare const LOCAL_CACHE_INTERVAL_KEY = "LOCAL_CACHE_INTERVAL";
+export declare const LOCAL_CACHE_INTERVAL = 1000;
+export declare const COLLAB_SUBMIT_CHANGESET_URL_KEY = "COLLAB_SUBMIT_CHANGESET_URL";
+/** The url prefix is determined by protocol in submodules/protocol/universer/v1/comb.proto */
+export declare const DEFAULT_COLLAB_SUBMIT_CHANGESET_URL = "/universer-api/comb";
+/**
+ * The config key to determined the URL provided by the auth server
+ */
+export declare const LOGIN_URL_KEY = "LOGIN_URL_KEY";
+export declare const DEFAULT_LOGIN_URL = "/universer-api/oidc/authpage";

package/lib/types/controllers/collab-cursor/sheet-collab-cursor-render.controller.d.ts

@@ -1,6 +1,5 @@
 import { IUniverInstanceService, RxDisposable, ThemeService } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
-import { SheetSkeletonManagerService } from '@univerjs/sheets-ui';
 import { CollabCursorController } from './collab-cursor.controller';
 
 /**
@@ -10,12 +9,13 @@ export declare class SheetCollabCursorRenderController extends RxDisposable {
     private readonly _collabCursorController;
     private readonly _univerInstanceService;
     private readonly _renderManagerService;
-    private readonly _sheetSkeletonManagerService;
     private readonly _themeService;
     /** Cursors stored for different Workbooks.  */
     private _cursors;
     private _lastPointer;
-    constructor(_collabCursorController: CollabCursorController, _univerInstanceService: IUniverInstanceService, _renderManagerService: IRenderManagerService, _sheetSkeletonManagerService: SheetSkeletonManagerService, _themeService: ThemeService);
+    private get _sheetSkeletonManagerService();
+    private get _unitId();
+    constructor(_collabCursorController: CollabCursorController, _univerInstanceService: IUniverInstanceService, _renderManagerService: IRenderManagerService, _themeService: ThemeService);
     private _init;
     private _updateCollabCursors;
     private _removeCollabCursors;

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

@@ -8,10 +8,6 @@ import { MemberService } from '../../services/member/member.service';
 import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
 import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 
-/**
- * Determines how often should we send changesets.
- */
-export declare const SEND_CHANGESET_TIMEOUT_KEY = "SEND_CHANGESET_TIMEOUT";
 /** Provide both states when and after changing, so the parent could examine if state transition is correct. */
 export type StateChangeHandler = (before: CollaborationState, after: CollaborationState) => void;
 /** A network interface to send changeset and  */

package/lib/types/index.d.ts

@@ -1,17 +1,15 @@
+export { SNAPSHOT_SERVER_URL_KEY, SNAPSHOT_URL_KEY, SEND_CHANGESET_TIMEOUT_KEY, COLLAB_WEB_SOCKET_URL_KEY, HEARTBEAT_INTERVAL_KEY, HEARTBEAT_TIMEOUT_KEY, LOCAL_CACHE_INTERVAL_KEY, COLLAB_SUBMIT_CHANGESET_URL_KEY, LOGIN_URL_KEY, } from './config/config';
 export { CollaborationController } from './controllers/collaboration/collaboration.controller';
-export { SEND_CHANGESET_TIMEOUT_KEY, CollaborationStatus, } from './controllers/collaboration/collaboration-state';
-export { CollaborationClientPlugin, type ICollaborationClientPluginConfig } from './plugin';
-export { COLLAB_WEB_SOCKET_URL_KEY, CollaborationSession, CollaborationSessionService, HEARTBEAT_INTERVAL_KEY, HEARTBEAT_TIMEOUT_KEY, SessionStatus, } from './services/collaboration-session/collaboration-session.service';
-export { LOCAL_CACHE_INTERVAL_KEY } from './services/local-cache/local-cache.service';
-export { SNAPSHOT_SERVER_URL_KEY } from './services/snapshot-server/snapshot-server.service';
+export { CollaborationStatus } from './controllers/collaboration/collaboration-state';
+export { UniverCollaborationClientPlugin, type ICollaborationClientPluginConfig } from './plugin';
+export { CollaborationSession, CollaborationSessionService, SessionStatus, } from './services/collaboration-session/collaboration-session.service';
 export type { ICollaborationSocket } from './services/socket/collaboration-socket.service';
-export { COLLAB_SUBMIT_CHANGESET_URL_KEY, CollaborationSocketService, ICollaborationSocketService, } from './services/socket/collaboration-socket.service';
+export { CollaborationSocketService, ICollaborationSocketService, } from './services/socket/collaboration-socket.service';
 export { LocalCacheService } from './services/local-cache/local-cache.service';
 export { IURLService } from './services/url/url.service';
 export { WebURLService } from './services/url/web-url.service';
 export { DataLoaderController } from './controllers/data-loader/data-loader.controller';
 export { DesktopCollaborationStatusDisplayController } from './controllers/collab-status/collab-status.controller';
-export { LOGIN_URL_KEY } from './services/auth-server/auth-server.service';
-export { AuthzIoHttpService } from './services/auth-server/authz-io-http.service';
+export { AUTHZ_URL_KEY, AuthzIoHttpService } from './services/auth-server/authz-io-http.service';
 export { deserializeToCombResponse, serializeCombRequest } from './services/socket/serialize';
 export { CollaborationStatusDisplay } from './views/components/CollabStatus';

package/lib/types/plugin.d.ts

@@ -1,4 +1,4 @@
-import { DependencyOverride, LocaleService, Plugin, UniverInstanceType } from '@univerjs/core';
+import { DependencyOverride, ILogService, Plugin, UniverInstanceType } from '@univerjs/core';
 import { Ctor, Injector } from '@wendellhu/redi';
 import { ICollaborationSocketService } from './services/socket/collaboration-socket.service';
 
@@ -13,12 +13,12 @@ export interface ICollaborationClientPluginConfig {
      */
     override?: DependencyOverride;
 }
-export declare class CollaborationClientPlugin extends Plugin {
+export declare class UniverCollaborationClientPlugin extends Plugin {
     private readonly _config;
+    private readonly _logService;
     protected _injector: Injector;
-    private readonly _localeService;
     static pluginName: string;
-    constructor(_config: ICollaborationClientPluginConfig | undefined, _injector: Injector, _localeService: LocaleService);
+    constructor(_config: ICollaborationClientPluginConfig | undefined, _logService: ILogService, _injector: Injector);
     onStarting(injector: Injector): void;
     private _initModules;
 }

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

@@ -1,10 +1,6 @@
 import { IConfigService, LocaleService } from '@univerjs/core';
 import { HTTPService } from '@univerjs/network';
 
-/**
- * The config key to determined the URL provided by the auth server
- */
-export declare const LOGIN_URL_KEY = "LOGIN_URL_KEY";
 export declare class AuthServerService {
     private readonly _configService;
     private readonly _httpService;

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

@@ -12,13 +12,6 @@ export declare enum SessionStatus {
     OFFLINE = 2,
     ONLINE = 3
 }
-export declare const COLLAB_WEB_SOCKET_URL_KEY = "COLLAB_WEB_SOCKET_URL";
-export declare const DEFAULT_COLLAB_WEB_SOCKET_URL = "ws://127.0.0.1:8000/universer-api/comb/connect";
-/** The heartbeat interval in milliseconds. */
-export declare const HEARTBEAT_INTERVAL_KEY = "HEARTBEAT_INTERVAL";
-export declare const HEARTBEAT_TIMEOUT_KEY = "HEARTBEAT_TIMEOUT";
-export declare const RETRY_CONNECTING_INTERVAL_KEY = "RETRY_CONNECTING_INTERVAL";
-export declare const RETRY_CONNECTING_MAX_COUNT_KEY = "RETRY_CONNECTING_MAX_COUNT";
 /**
  * The data structure to represent a collaboration session. It also manages the collaborator's identity.
  *

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

@@ -10,11 +10,6 @@ export interface IUnitCacheData {
     awaitingChangeset: Nullable<IChangeset>;
     mutations: IMutationInfo[];
 }
-/**
- * A config key to determine how often should Univer save local edits.
- */
-export declare const LOCAL_CACHE_INTERVAL_KEY = "LOCAL_CACHE_INTERVAL";
-export declare const LOCAL_CACHE_INTERVAL = 1000;
 /**
  * This service provide caching to the collaboration controller.
  */

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

@@ -1,4 +1,4 @@
-import { Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { Nullable, Disposable, IUniverInstanceService, UserManagerService } from '@univerjs/core';
 import { IMember } from '@univerjs/protocol';
 
 export interface IUser extends IMember {
@@ -9,10 +9,16 @@ export interface IUser extends IMember {
  */
 export declare class MemberService extends Disposable {
     private readonly _univerInstanceService;
+    private _userManagerService;
     private _roomMembers;
-    private _currentUser;
-    constructor(_univerInstanceService: IUniverInstanceService);
+    constructor(_univerInstanceService: IUniverInstanceService, _userManagerService: UserManagerService);
+    /**
+     * @deprecated please use userManagerService
+     */
     setCurrentUser(user: IUser): void;
+    /**
+     * @deprecated please use userManagerService
+     */
     getCurrentUser(): Nullable<IUser>;
     updateMember(roomID: string, member: IMember): void;
     removeMember(roomID: string, memberID: string): void;

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

@@ -2,11 +2,6 @@ import { ILogContext, ISnapshotServerService, IConfigService } from '@univerjs/c
 import { HTTPService } from '@univerjs/network';
 import { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetResponse, ISaveSheetBlockResponse, ISaveSnapshotResponse } from '@univerjs/protocol';
 
-/**
- * The config key to determined the URL provided by the snapshot server
- * to load snapshot. The URL should not ends with a slash.
- */
-export declare const SNAPSHOT_SERVER_URL_KEY = "SNAPSHOT_SERVER_URL_KEY";
 export declare class SnapshotServerOverHTTPService implements ISnapshotServerService {
     private readonly _configService;
     private readonly _httpService;
@@ -14,7 +9,8 @@ export declare class SnapshotServerOverHTTPService implements ISnapshotServerSer
     getUnitOnRev(_context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
     getSheetBlock(_context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;
     fetchMissingChangesets(_context: ILogContext, params: IFetchMissingChangesetsRequest): Promise<IFetchMissingChangesetsResponse>;
-    private _getAPIPrefixPath;
+    private _getSnapshotAPIPrefix;
+    private _getAPIPrefix;
     getResourcesRequest(_context: ILogContext, params: IGetResourcesRequest): Promise<IGetResourcesResponse>;
     saveSnapshot(): Promise<ISaveSnapshotResponse>;
     saveSheetBlock(): Promise<ISaveSheetBlockResponse>;

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

@@ -17,7 +17,6 @@ export interface ICollaborationSocketService {
     createSocket: (url: string) => Nullable<ICollaborationSocket>;
 }
 export declare const ICollaborationSocketService: import('@wendellhu/redi').IdentifierDecorator<ICollaborationSocketService>;
-export declare const COLLAB_SUBMIT_CHANGESET_URL_KEY = "COLLAB_SUBMIT_CHANGESET_URL";
 export declare class CollaborationSocketService implements ICollaborationSocketService {
     protected readonly _http: HTTPService;
     protected readonly _ws: WebSocketService;