@univerjs-pro/collaboration-client 0.1.10 → 0.1.11

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

@@ -1,8 +1,8 @@
-import { CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
-import { IDocCollabCursor, ISheetCollabCursor } from '../../models/cursor';
-import { Observable } from 'rxjs';
-import { Injector } from '@wendellhu/redi';
 import { IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { Injector } from '@wendellhu/redi';
+import { Observable } from 'rxjs';
+import { IDocCollabCursor, ISheetCollabCursor } from '../../models/cursor';
+import { CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
 
 /**
  * This controller adds collaboration cursors to Univer. It works with `CollabCursorRenderController`.

package/lib/types/controllers/collab-cursor/doc-collab-cursor-entity.d.ts

@@ -1,11 +1,11 @@
-import { DocSyncEditingCollabCursorService } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
-import { MemberService } from '../../services/member/member.service';
-import { ColorAssignService } from '../../services/color-assign/color-assign.service';
-import { CollaborationSession } from '../../services/collaboration-session/collaboration-session.service';
-import { IDocCollabCursor } from '../../models/cursor';
-import { Injector } from '@wendellhu/redi';
-import { ICollaborationUser, ITransformService } from '@univerjs-pro/collaboration';
 import { ICommandService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { ICollaborationUser, ITransformService } from '@univerjs-pro/collaboration';
+import { Injector } from '@wendellhu/redi';
+import { IDocCollabCursor } from '../../models/cursor';
+import { CollaborationSession } from '../../services/collaboration-session/collaboration-session.service';
+import { ColorAssignService } from '../../services/color-assign/color-assign.service';
+import { MemberService } from '../../services/member/member.service';
+import { DocSyncEditingCollabCursorService } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 
 /**
  * Each univer document instance would map to an `CollabCursorEntity` to handle collaborated editing events.

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

@@ -1,7 +1,7 @@
-import { CollabCursorController } from './collab-cursor.controller';
-import { DocSkeletonManagerService } from '@univerjs/docs';
-import { IRenderManagerService } from '@univerjs/engine-render';
 import { IUniverInstanceService, RxDisposable, ThemeService } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { DocSkeletonManagerService } from '@univerjs/docs';
+import { CollabCursorController } from './collab-cursor.controller';
 
 /**
  * This controller works with `CollabCursorController` to render doc collaboration cursors.

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

@@ -1,11 +1,11 @@
-import { MemberService } from '../../services/member/member.service';
-import { ColorAssignService } from '../../services/color-assign/color-assign.service';
-import { CollaborationSession } from '../../services/collaboration-session/collaboration-session.service';
-import { ISheetCollabCursor } from '../../models/cursor';
-import { Injector } from '@wendellhu/redi';
-import { ICollaborationUser } from '@univerjs-pro/collaboration';
-import { RefRangeService } from '@univerjs/sheets';
 import { ICommandService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { RefRangeService } from '@univerjs/sheets';
+import { ICollaborationUser } from '@univerjs-pro/collaboration';
+import { Injector } from '@wendellhu/redi';
+import { ISheetCollabCursor } from '../../models/cursor';
+import { CollaborationSession } from '../../services/collaboration-session/collaboration-session.service';
+import { ColorAssignService } from '../../services/color-assign/color-assign.service';
+import { MemberService } from '../../services/member/member.service';
 
 /**
  * Each univer document instance would map to an `CollabCursorEntity` to handle collaborated editing events.

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

@@ -1,7 +1,7 @@
-import { CollabCursorController } from './collab-cursor.controller';
-import { SheetSkeletonManagerService } from '@univerjs/sheets-ui';
-import { IRenderManagerService } from '@univerjs/engine-render';
 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';
 
 /**
  * This controller works with `CollabCursorController` to render sheet collaboration cursors.

package/lib/types/controllers/collab-status/collab-status.controller.d.ts

@@ -1,7 +1,7 @@
-import { CollaborationController } from '../collaboration/collaboration.controller';
-import { Injector } from '@wendellhu/redi';
-import { IDesktopUIController } from '@univerjs/ui';
 import { Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IDesktopUIController } from '@univerjs/ui';
+import { Injector } from '@wendellhu/redi';
+import { CollaborationController } from '../collaboration/collaboration.controller';
 
 /**
  * This controller is responsible for monitoring the collaboration status of the currently focused unit.

package/lib/types/controllers/collaboration/__tests__/mock-text-selection-render-manager.service.d.ts

@@ -1,5 +1,5 @@
-import { ITextSelectionInnerParam } from '@univerjs/engine-render';
 import { Nullable } from '@univerjs/core';
+import { ITextSelectionInnerParam } from '@univerjs/engine-render';
 
 export declare class TextSelectionRenderManager {
     private readonly _textSelectionInner$;

package/lib/types/controllers/collaboration/__tests__/mocks.d.ts

@@ -1,10 +1,10 @@
-import { ICollaborationSocket, ICollaborationSocketService } from '../../../services/socket/collaboration-socket.service';
-import { Subject } from 'rxjs';
-import { IDisposable } from '@wendellhu/redi';
-import { ICombResponseEvent } from '@univerjs-pro/collaboration';
-import { IBeforeCloseService, IMessageService, INotificationService } from '@univerjs/ui';
-import { IMessageMethodOptions, IMessageProps } from '@univerjs/design';
 import { ILocalStorageService, Nullable, ILogService } from '@univerjs/core';
+import { IMessageMethodOptions, IMessageProps } from '@univerjs/design';
+import { IBeforeCloseService, IMessageService, INotificationService } from '@univerjs/ui';
+import { ICombResponseEvent } from '@univerjs-pro/collaboration';
+import { IDisposable } from '@wendellhu/redi';
+import { Subject } from 'rxjs';
+import { ICollaborationSocket, ICollaborationSocketService } from '../../../services/socket/collaboration-socket.service';
 
 /**
  * The handler object for a mocked socket connection. You can terminate, send messages / error through this object.

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

@@ -1,12 +1,12 @@
-import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
-import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
-import { MemberService } from '../../services/member/member.service';
-import { LocalCacheService } from '../../services/local-cache/local-cache.service';
-import { Injector } from '@wendellhu/redi';
-import { UniverType } from '@univerjs/protocol';
-import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
-import { INotificationService } from '@univerjs/ui';
 import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, IUniverInstanceService, LocaleService, UniverPermissionService } from '@univerjs/core';
+import { INotificationService } from '@univerjs/ui';
+import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
+import { UniverType } from '@univerjs/protocol';
+import { Injector } from '@wendellhu/redi';
+import { LocalCacheService } from '../../services/local-cache/local-cache.service';
+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.

package/lib/types/controllers/collaboration/collaboration.controller.d.ts

@@ -1,18 +1,18 @@
-import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
-import { SheetTransformSelectionsService } from '../../services/range-selection/sheet-transform-selections.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';
-import { DocTransformIMECacheService } from '../../services/ime-cache-transform/doc-transform-ime-cache.service';
-import { ISingleActiveUnitService } from '../../services/single-active-unit/single-active-unit.service';
-import { LocalCacheService } from '../../services/local-cache/local-cache.service';
-import { CollaborationSession, CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
-import { DocStateChangeManagerService } from '@univerjs/docs';
-import { Observable, BehaviorSubject } from 'rxjs';
-import { IDisposable, Injector } from '@wendellhu/redi';
-import { UniverType } from '@univerjs/protocol';
-import { CompressMutationService, RevisionService } from '@univerjs-pro/collaboration';
-import { IMessageService } from '@univerjs/ui';
 import { IMutationInfo, Nullable, ICommandService, ILogService, IUniverInstanceService, LocaleService, RxDisposable, UniverPermissionService } from '@univerjs/core';
+import { IMessageService } from '@univerjs/ui';
+import { CompressMutationService, RevisionService } from '@univerjs-pro/collaboration';
+import { UniverType } from '@univerjs/protocol';
+import { IDisposable, Injector } from '@wendellhu/redi';
+import { Observable, BehaviorSubject } from 'rxjs';
+import { DocStateChangeManagerService } from '@univerjs/docs';
+import { CollaborationSession, CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
+import { LocalCacheService } from '../../services/local-cache/local-cache.service';
+import { ISingleActiveUnitService } from '../../services/single-active-unit/single-active-unit.service';
+import { DocTransformIMECacheService } from '../../services/ime-cache-transform/doc-transform-ime-cache.service';
+import { DocTransformSelectionsService } from '../../services/text-selection/doc-transform-selections.service';
+import { DocSyncEditingCollabCursorService } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
+import { SheetTransformSelectionsService } from '../../services/range-selection/sheet-transform-selections.service';
+import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
 
 export declare class CollaborationController extends RxDisposable {
     private readonly _injector;

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

@@ -1,6 +1,6 @@
-import { MemberService } from '../../../services/member/member.service';
-import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
 import { IMutationInfo, IUniverInstanceService } from '@univerjs/core';
+import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
+import { MemberService } from '../../../services/member/member.service';
 
 export interface IAssembledChangeset {
     changeset: IChangeset;

package/lib/types/controllers/data-loader/data-loader.controller.d.ts

@@ -1,11 +1,11 @@
-import { IURLService } from '../../services/url/url.service';
-import { LocalCacheService } from '../../services/local-cache/local-cache.service';
-import { SnapshotService } from '@univerjs-pro/collaboration';
-import { IRemoteInstanceService } from '@univerjs/rpc';
 import { ICommandService, ILogService, RxDisposable } from '@univerjs/core';
+import { IRemoteInstanceService } from '@univerjs/rpc';
+import { SnapshotService } from '@univerjs-pro/collaboration';
+import { LocalCacheService } from '../../services/local-cache/local-cache.service';
+import { IURLService } from '../../services/url/url.service';
 
 /**
- * This controller loads data from the server.
+ * This controller loads data when URL changes.
  */
 export declare class DataLoaderController extends RxDisposable {
     private _urlService;

package/lib/types/index.d.ts

@@ -6,6 +6,10 @@ export { LOCAL_CACHE_INTERVAL_KEY } from './services/local-cache/local-cache.ser
 export { SNAPSHOT_SERVER_URL_KEY } from './services/snapshot-server/snapshot-server.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 { 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 { LOGIN_URL_KEY } from './services/auth-server/auth-server.service';
 export { deserializeToCombResponse, serializeCombRequest } from './services/socket/serialize';
 export { enUS, zhCN } from './locale';

package/lib/types/models/cursor.d.ts

@@ -1,5 +1,5 @@
-import { ITextRangeWithStyle } from '@univerjs/engine-render';
 import { IRange } from '@univerjs/core';
+import { ITextRangeWithStyle } from '@univerjs/engine-render';
 
 /**
  * The data structure to store collab cursor info of sheet.

package/lib/types/plugin.d.ts

@@ -1,6 +1,6 @@
-import { ICollaborationSocketService } from './services/socket/collaboration-socket.service';
+import { DependencyOverride, LocaleService, Plugin, UniverInstanceType } from '@univerjs/core';
 import { Ctor, Injector } from '@wendellhu/redi';
-import { LocaleService, Plugin, UniverInstanceType } from '@univerjs/core';
+import { ICollaborationSocketService } from './services/socket/collaboration-socket.service';
 
 export interface ICollaborationClientPluginConfig {
     socketService?: Ctor<ICollaborationSocketService>;
@@ -8,6 +8,10 @@ export interface ICollaborationClientPluginConfig {
     enableSingleActiveInstanceLock?: boolean;
     collaborationUniverTypes?: UniverInstanceType[];
     enableAuthServer?: boolean;
+    /**
+     * Override internal modules with custom implementations.
+     */
+    override?: DependencyOverride;
 }
 export declare class CollaborationClientPlugin extends Plugin {
     private readonly _config;

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

@@ -1,5 +1,5 @@
-import { HTTPService } from '@univerjs/network';
 import { IConfigService, LocaleService } from '@univerjs/core';
+import { HTTPService } from '@univerjs/network';
 
 /**
  * The config key to determined the URL provided by the auth server

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

@@ -1,10 +1,10 @@
-import { ICollaborationSocket, ICollaborationSocketService } from '../socket/collaboration-socket.service';
-import { MemberService } from '../member/member.service';
-import { Observable } from 'rxjs';
-import { IDisposable, Injector } from '@wendellhu/redi';
-import { ICollaborationEvent } from '@univerjs-pro/collaboration';
-import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
 import { Nullable, Disposable, IConfigService, ILogService, LocaleService, RxDisposable } from '@univerjs/core';
+import { IBeforeCloseService, IMessageService } from '@univerjs/ui';
+import { ICollaborationEvent } from '@univerjs-pro/collaboration';
+import { IDisposable, Injector } from '@wendellhu/redi';
+import { Observable } from 'rxjs';
+import { MemberService } from '../member/member.service';
+import { ICollaborationSocket, ICollaborationSocketService } from '../socket/collaboration-socket.service';
 
 export declare enum SessionStatus {
     IDLE = 0,

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

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

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

@@ -1,7 +1,7 @@
-import { UniverType } from '@univerjs/protocol';
-import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
-import { IBeforeCloseService } from '@univerjs/ui';
 import { IMutationInfo, Nullable, Disposable, IConfigService, ILocalStorageService, LocaleService } from '@univerjs/core';
+import { IBeforeCloseService } from '@univerjs/ui';
+import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
+import { UniverType } from '@univerjs/protocol';
 
 export interface IUnitCacheData {
     unitID: string;

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

@@ -1,5 +1,5 @@
-import { IMember } from '@univerjs/protocol';
 import { Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { IMember } from '@univerjs/protocol';
 
 export interface IUser extends IMember {
     userID: string;

package/lib/types/services/range-selection/sheet-transform-selections.service.d.ts

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

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

@@ -1,5 +1,5 @@
-import { Observable } from 'rxjs';
 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,

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

@@ -1,6 +1,6 @@
-import { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetResponse, ISaveSheetBlockResponse, ISaveSnapshotResponse } from '@univerjs/protocol';
-import { HTTPService } from '@univerjs/network';
 import { ILogContext, ISnapshotServerService, IConfigService } from '@univerjs/core';
+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

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

@@ -1,8 +1,8 @@
-import { Observable } from 'rxjs';
-import { IChangeset } from '@univerjs/protocol';
-import { ICombRequestEvent, ICombResponseEvent, IFetchingMissEvent, ISubmitChangesetEvent } from '@univerjs-pro/collaboration';
-import { ISocket, HTTPService, WebSocketService } from '@univerjs/network';
 import { Nullable, IConfigService, ILogService, ISnapshotServerService } from '@univerjs/core';
+import { ISocket, HTTPService, WebSocketService } from '@univerjs/network';
+import { ICombRequestEvent, ICombResponseEvent, IFetchingMissEvent, ISubmitChangesetEvent } from '@univerjs-pro/collaboration';
+import { IChangeset } from '@univerjs/protocol';
+import { Observable } from 'rxjs';
 
 export interface ICollaborationSocket extends Pick<ISocket, 'open$' | 'error$' | 'close$'> {
     memberID: string;

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

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

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

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

package/lib/types/services/undoredo/collaborative-undoredo.service.d.ts

@@ -1,5 +1,5 @@
-import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 import { IUndoRedoService, ICommandService, IContextService, ILogService, IUniverInstanceService, LocalUndoRedoService } from '@univerjs/core';
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 
 /**
  * `LocalUndoRedoService` cannot transform mutations in the undo redo stack under collaboration conditions.

package/lib/types/services/url/web-url.service.d.ts

@@ -1,6 +1,6 @@
-import { IURLService } from './url.service';
-import { Observable } from 'rxjs';
 import { RxDisposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
+import { IURLService } from './url.service';
 
 export declare class WebURLService extends RxDisposable implements IURLService {
     readonly urlChange$: Observable<void>;

package/lib/types/views/components/CollabStatus.d.ts

@@ -1,5 +1,5 @@
-import { CollaborationStatus } from '../../controllers/collaboration/collaboration-state';
 import { Observable } from 'rxjs';
+import { CollaborationStatus } from '../../controllers/collaboration/collaboration-state';
 
 export interface IOnlineStatusProps {
     /** The collaboration state of the currently focused unit. */

package/lib/types/views/components/CollabStatus.stories.d.ts

@@ -1,6 +1,6 @@
-import { CollaborationStatusDisplay } from './CollabStatus';
-import { default as React } from 'react';
 import { Meta } from '@storybook/react';
+import { default as React } from 'react';
+import { CollaborationStatusDisplay } from './CollabStatus';
 
 declare const meta: Meta<typeof CollaborationStatusDisplay>;
 export default meta;

package/lib/types/views/shapes/doc-collab-cursor.d.ts

@@ -1,5 +1,5 @@
-import { IDocCollabCursor } from '../../models/cursor';
 import { Documents, DocumentSkeleton, Scene } from '@univerjs/engine-render';
+import { IDocCollabCursor } from '../../models/cursor';
 
 /**
  * Render a single collaborated cursor on the canvas.

package/lib/types/views/shapes/sheet-collab-cursor.shape.d.ts

@@ -1,5 +1,5 @@
-import { ISheetCollabCursor } from '../../models/cursor';
 import { IMouseEvent, IPointerEvent, IShapeProps, Shape } from '@univerjs/engine-render';
+import { ISheetCollabCursor } from '../../models/cursor';
 
 export declare const SHEET_COLLAB_CURSOR_ZINDEX = 1;
 export declare const SHEET_COLLAB_CURSOR_BORDER_WIDTH = 1.5;