@univerjs-pro/collaboration-client-ui 0.25.0 → 1.0.0-alpha.0

package/lib/types/{controllers/config.schema.d.ts → config/config.d.ts}

@@ -6,6 +6,14 @@ export interface IUniverCollaborationClientUIConfig {
      * Override internal modules with custom implementations.
      */
     override?: DependencyOverride;
+    /**
+     * Whether to enable collaboration UI pieces that depend on Docs UI.
+     * Keep this enabled for Docs/Sheets, and disable it for non-Docs hosts
+     * such as Bases that only need the browser collaboration services.
+     *
+     * @default true
+     */
+    enableDocumentCollaborationUI?: boolean;
     /**
      * Whether to enable frontend log.
      * @default false

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

@@ -1,5 +1,5 @@
 import type { Observable } from 'rxjs';
-import type { IDocCollabCursor, ISheetCollabCursor } from '../../models/cursor';
+import type { IDocCollabCursor, ISheetCollabCursor, ISlideCollabCursor } from '../../models/cursor';
 import { CollaborationSessionService } from '@univerjs-pro/collaboration-client';
 import { Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
 /**
@@ -15,8 +15,9 @@ export declare class CollabCursorController extends RxDisposable {
     private readonly _entityInit$;
     constructor(_univerInstanceService: IUniverInstanceService, _injector: Injector, _collabSessionService: CollaborationSessionService);
     dispose(): void;
-    getCollabCursors$(unitID: string): Observable<Map<string, ISheetCollabCursor> | Map<string, IDocCollabCursor>>;
+    getCollabCursors$(unitID: string): Observable<Map<string, ISheetCollabCursor> | Map<string, IDocCollabCursor> | Map<string, ISlideCollabCursor>>;
     private _init;
     private _startSheetCollabCursor;
     private _startDocCollabCursor;
+    private _startSlideCollabCursor;
 }

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

@@ -0,0 +1,34 @@
+import type { ICollaborationUser } from '@univerjs-pro/collaboration';
+import type { CollaborationSession } from '@univerjs-pro/collaboration-client';
+import type { ISlideCollabCursor, ISlideCollabSelectionPayload } from '../../models/cursor';
+import { MemberService } from '@univerjs-pro/collaboration-client';
+import { ISlideDrawingStateService } from '@univerjs-pro/slides-ui';
+import { RxDisposable } from '@univerjs/core';
+import { ColorAssignService } from '../../services/color-assign/color-assign.service';
+export declare function parseSlideCursorSelection(selection: string): ISlideCollabSelectionPayload | null;
+/**
+ * Stores slide collaborator cursor presence without mutating local slide selection.
+ */
+export declare class SlideCollabCursorEntity extends RxDisposable {
+    readonly unitID: string;
+    private readonly _session;
+    private readonly _colorAssignService;
+    private readonly _memberService;
+    private readonly _slideDrawingStateService;
+    private _online;
+    private _init;
+    private _cursorInfo$;
+    cursorInfo$: import("rxjs").Observable<Map<string, ISlideCollabCursor>>;
+    get cursorInfo(): Readonly<Map<string, ISlideCollabCursor>>;
+    private _roomMembers$;
+    roomMembers$: import("rxjs").Observable<ICollaborationUser[]>;
+    get roomMembers(): Readonly<ICollaborationUser[]>;
+    constructor(unitID: string, _session: CollaborationSession, _colorAssignService: ColorAssignService, _memberService: MemberService, _slideDrawingStateService: ISlideDrawingStateService);
+    dispose(): void;
+    init(): void;
+    private _onCursorUpdate;
+    private _onCursorDelete;
+    private _updateLocalCursor;
+    private _toggleOnline;
+    private _toggleOffline;
+}

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

@@ -0,0 +1,21 @@
+import type { SlideModel } from '@univerjs-pro/slides';
+import type { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { RxDisposable, ThemeService } from '@univerjs/core';
+import { CollabCursorController } from './collab-cursor.controller';
+export declare class SlideCollabCursorRenderController extends RxDisposable implements IRenderModule {
+    private readonly _context;
+    private readonly _collabCursorController;
+    private readonly _themeService;
+    private _cursors;
+    private _renderScheduled;
+    private _isApplyingOverlays;
+    private _latestCursors;
+    constructor(_context: IRenderContext<SlideModel>, _collabCursorController: CollabCursorController, _themeService: ThemeService);
+    dispose(): void;
+    private _init;
+    private _scheduleRender;
+    private _render;
+    private _removeCollabCursors;
+    private _getSceneObjectByKey;
+    private _getObjectBounds;
+}

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

@@ -1,6 +1,5 @@
 import { CollaborationController, CollaborationStatus } from '@univerjs-pro/collaboration-client';
 import { Disposable, LocaleService } from '@univerjs/core';
-import { DocStateChangeManagerService } from '@univerjs/docs-ui';
 import { IMessageService } from '@univerjs/ui';
 import { BehaviorSubject } from 'rxjs';
 import { DocTransformIMECacheService } from '../../services/ime-cache-transform/doc-transform-ime-cache.service';
@@ -11,7 +10,6 @@ import { DocTransformSelectionsService } from '../../services/text-selection/doc
  * This controller is responsible for monitoring the collaboration status of the currently focused unit.
  */
 export declare class CollaborationEntityUIController extends Disposable {
-    private readonly _docStateChangeManagerService;
     private readonly _collaborationController;
     private readonly _docTransformIMECacheService;
     private readonly _docTransformStateCacheService;
@@ -20,6 +18,6 @@ export declare class CollaborationEntityUIController extends Disposable {
     protected readonly _messageService: IMessageService;
     protected readonly _localeService: LocaleService;
     protected readonly _status$: BehaviorSubject<CollaborationStatus>;
-    constructor(_docStateChangeManagerService: DocStateChangeManagerService, _collaborationController: CollaborationController, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformStateCacheService: DocTransformStateCacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, _messageService: IMessageService, _localeService: LocaleService);
+    constructor(_collaborationController: CollaborationController, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformStateCacheService: DocTransformStateCacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, _messageService: IMessageService, _localeService: LocaleService);
     private _initEntityListener;
 }

package/lib/types/index.d.ts

@@ -1,6 +1,6 @@
 import './global.css';
+export type { IUniverCollaborationClientUIConfig } from './config/config';
 export { DesktopCollaborationStatusDisplayController } from './controllers/collab-status/collab-status.controller';
-export type { IUniverCollaborationClientUIConfig } from './controllers/config.schema';
 export { CollaborationDataLoaderController } from './controllers/data-loader/data-loader.controller';
 export { UniverCollaborationClientUIPlugin } from './plugin';
 export { BrowserCollaborationSocketService } from './services/collaboration-socket/collaboration-socket.service';
@@ -8,4 +8,5 @@ export { RemoteUniscriptService } from './services/remote-uniscript/remote-unisc
 export { WebBrowserSingleActiveUnitService } from './services/single-active-unit/single-active-unit.service';
 export { IURLService } from './services/url/url.service';
 export { WebURLService } from './services/url/web-url.service';
-export { type ISheetCollabCursorShapeProps, SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';
+export { SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';
+export type { ISheetCollabCursorShapeProps } from './views/shapes/sheet-collab-cursor.shape';

package/lib/types/locale/types.d.ts

@@ -0,0 +1,3 @@
+import type { LocaleLeafKeys } from '@univerjs/core';
+import type enUS from './en-US';
+export type LocaleKey = LocaleLeafKeys<typeof enUS>;

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

@@ -34,3 +34,26 @@ export interface IDocCollabCursor {
     /** The deserialized ranges of collab cursor. */
     ranges: ITextRangeWithStyle[];
 }
+export interface ISlideCollabSelectionPayload {
+    kind: 'slide-element-selection';
+    unitId: string;
+    subUnitId: string;
+    selectedIds: string[];
+    focusedId: string | null;
+}
+export interface ISlideCollabCursor {
+    /** Stroke color of this collab cursor */
+    color: string;
+    /** Displayed user name of this cursor */
+    name: string;
+    /** Slide unit ID */
+    unitId: string;
+    /** Slide page ID */
+    subUnitId: string;
+    /** Remote selected drawing IDs */
+    selectedIds: string[];
+    /** Remote focused drawing ID */
+    focusedId: string | null;
+    /** Serialized slide selection payload */
+    selection: string;
+}

package/lib/types/plugin.d.ts

@@ -1,4 +1,4 @@
-import type { IUniverCollaborationClientUIConfig } from './controllers/config.schema';
+import type { IUniverCollaborationClientUIConfig } from './config/config';
 import { IConfigService, Injector, Plugin } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
 export declare class UniverCollaborationClientUIPlugin extends Plugin {

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

@@ -20,6 +20,7 @@ export declare class WebLocalCacheService extends Disposable implements ILocalCa
     dispose(): void;
     loadOfflineData(unitID: string): Promise<Nullable<IUnitCacheData>>;
     saveOfflineData(unitID: string, data: IUnitCacheData): Promise<boolean>;
+    backupOfflineData(unitID: string, reason: string): Promise<void>;
     updateOfflineData(unitID: string, type: UniverInstanceType, awaitingChangeset: Nullable<IChangeset>, pendingMutations: IMutationInfo[]): void;
     private _scheduleSaving;
     private _getSaveTimeout;

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

@@ -1,7 +1,7 @@
 import type { IChangeset } from '@univerjs-pro/collaboration';
 import { ITransformService } from '@univerjs-pro/collaboration';
 import { Injector } from '@univerjs/core';
-import { DocStateChangeManagerService } from '@univerjs/docs-ui';
+import { DocStateChangeManagerService } from '@univerjs/docs';
 export declare class DocTransformStateCacheService {
     private readonly _injector;
     private readonly _transformService;

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

@@ -18,4 +18,4 @@ export interface IOnlineStatusProps {
  * <CollaborationStatusDisplay status$={statusObservable} />
  * ```
  */
-export declare function CollaborationStatusDisplay(props: Readonly<IOnlineStatusProps>): import("react/jsx-runtime").JSX.Element;
+export declare function CollaborationStatusDisplay(props: Readonly<IOnlineStatusProps>): import("react").JSX.Element;

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

@@ -0,0 +1,15 @@
+import type { IShapeProps } from '@univerjs/engine-render';
+import type { ISlideCollabCursor } from '../../models/cursor';
+import { Shape } from '@univerjs/engine-render';
+export declare const SLIDE_COLLAB_CURSOR_ZINDEX = 5002;
+export interface ISlideCollabCursorShapeProps extends IShapeProps, ISlideCollabCursor {
+    showText?: boolean;
+}
+export declare class SlideCollabCursorShape<T extends ISlideCollabCursorShapeProps = ISlideCollabCursorShapeProps> extends Shape<T> {
+    private _color;
+    private _name;
+    private _showText;
+    constructor(key?: string, props?: T);
+    setShapeProps(props: Partial<ISlideCollabCursorShapeProps>): void;
+    protected _draw(ctx: CanvasRenderingContext2D): void;
+}

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(_0xe7bca9,_0xfa391d){var _0x3d9348=_0x103e,_0x49a20a=_0xe7bca9();while(!![]){try{var _0x5a732e=parseInt(_0x3d9348(0x17b))/0x1+-parseInt(_0x3d9348(0x185))/0x2*(-parseInt(_0x3d9348(0x17c))/0x3)+parseInt(_0x3d9348(0x18a))/0x4*(parseInt(_0x3d9348(0x189))/0x5)+parseInt(_0x3d9348(0x17d))/0x6*(-parseInt(_0x3d9348(0x18d))/0x7)+-parseInt(_0x3d9348(0x188))/0x8+-parseInt(_0x3d9348(0x186))/0x9+parseInt(_0x3d9348(0x182))/0xa;if(_0x5a732e===_0xfa391d)break;else _0x49a20a['push'](_0x49a20a['shift']());}catch(_0x4588c6){_0x49a20a['push'](_0x49a20a['shift']());}}}(_0x9453,0x250b4),function(_0x5a5ea9,_0x10d0b7){var _0x12aa1e=_0x103e;typeof exports==_0x12aa1e(0x18e)&&typeof module<'u'?_0x10d0b7(require('@univerjs-pro/collaboration-client-ui'),require('@univerjs/core/facade')):typeof define==_0x12aa1e(0x17f)&&define['amd']?define([_0x12aa1e(0x180),_0x12aa1e(0x18c)],_0x10d0b7):(_0x5a5ea9=typeof globalThis<'u'?globalThis:_0x5a5ea9||self,_0x10d0b7(_0x5a5ea9['UniverProCollaborationClientUi'],_0x5a5ea9[_0x12aa1e(0x183)]));}(this,function(_0x2f395c,_0x501d9d){var _0x5b4e76=_0x103e,_0x4f2427=class extends _0x501d9d[_0x5b4e76(0x18b)]{['runOnServer'](_0x469574,_0x3c8f88,..._0x4675b0){var _0x45c3c2=_0x5b4e76;return this[_0x45c3c2(0x187)][_0x45c3c2(0x181)](_0x2f395c['RemoteUniscriptService'])[_0x45c3c2(0x184)](_0x469574,_0x3c8f88,{},..._0x4675b0);}};_0x501d9d[_0x5b4e76(0x18b)][_0x5b4e76(0x17e)](_0x4f2427);}));function _0x103e(_0x228fc1,_0x1f1cc8){_0x228fc1=_0x228fc1-0x17b;var _0x945366=_0x9453();var _0x103ea3=_0x945366[_0x228fc1];return _0x103ea3;}function _0x9453(){var _0x5bb614=['138593UDbDwr','15etYUzr','6wBecBa','extend','function','@univerjs-pro/collaboration-client-ui','get','3341360GCcBzT','UniverCoreFacade','runOnServer','6162mRgTmM','582435LoOVvj','_injector','1554696oKvCeK','5gIJXqe','618556nXqgbY','FUniver','@univerjs/core/facade','1623923LlTZbX','object'];_0x9453=function(){return _0x5bb614;};return _0x9453();}
+function _0xfa34(_0x40b8cd,_0x1f6dd3){_0x40b8cd=_0x40b8cd-0x109;var _0x1a42a5=_0x1a42();var _0xfa3462=_0x1a42a5[_0x40b8cd];return _0xfa3462;}function _0x1a42(){var _0x252458=['object','2661aGfqnV','28836zvRBuA','1115348JHyQRn','489551eARGBt','@univerjs/core/facade','runOnServer','UniverCoreFacade','1324VPoqsL','FUniver','5YJooYm','1829331zDkDdH','_injector','amd','901434ceLKBQ','14987380EgoreO','UniverProCollaborationClientUi','extend','function','1552aqlMSO'];_0x1a42=function(){return _0x252458;};return _0x1a42();}(function(_0x3daac8,_0x2e088a){var _0x5a365c=_0xfa34,_0x13af6c=_0x3daac8();while(!![]){try{var _0x3e9828=parseInt(_0x5a365c(0x116))/0x1+parseInt(_0x5a365c(0x115))/0x2+parseInt(_0x5a365c(0x113))/0x3*(parseInt(_0x5a365c(0x11a))/0x4)+-parseInt(_0x5a365c(0x11c))/0x5*(-parseInt(_0x5a365c(0x10c))/0x6)+-parseInt(_0x5a365c(0x109))/0x7+parseInt(_0x5a365c(0x111))/0x8*(parseInt(_0x5a365c(0x114))/0x9)+-parseInt(_0x5a365c(0x10d))/0xa;if(_0x3e9828===_0x2e088a)break;else _0x13af6c['push'](_0x13af6c['shift']());}catch(_0x254997){_0x13af6c['push'](_0x13af6c['shift']());}}}(_0x1a42,0x56136),function(_0x39d22a,_0x6d16eb){var _0x5d05df=_0xfa34;typeof exports==_0x5d05df(0x112)&&typeof module<'u'?_0x6d16eb(require('@univerjs-pro/collaboration-client-ui'),require('@univerjs/core/facade')):typeof define==_0x5d05df(0x110)&&define[_0x5d05df(0x10b)]?define(['@univerjs-pro/collaboration-client-ui',_0x5d05df(0x117)],_0x6d16eb):(_0x39d22a=typeof globalThis<'u'?globalThis:_0x39d22a||self,_0x6d16eb(_0x39d22a[_0x5d05df(0x10e)],_0x39d22a[_0x5d05df(0x119)]));}(this,function(_0x19c0ef,_0x12e620){var _0x84569b=_0xfa34,_0x4d5875=class extends _0x12e620[_0x84569b(0x11b)]{[_0x84569b(0x118)](_0x1941ec,_0x88b215,..._0x27d59f){var _0x18f77f=_0x84569b;return this[_0x18f77f(0x10a)]['get'](_0x19c0ef['RemoteUniscriptService'])[_0x18f77f(0x118)](_0x1941ec,_0x88b215,{},..._0x27d59f);}};_0x12e620[_0x84569b(0x11b)][_0x84569b(0x10f)](_0x4d5875);}));