@univerjs-pro/collaboration-client-ui 0.5.1-nightly.202412051606

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

@@ -0,0 +1,58 @@
+import { IDisposable, ILocalStorageService, Nullable, ILogService } from '@univerjs/core';
+import { IMessageOptions, IMessageProps } from '@univerjs/design';
+import { HTTPResponse } from '@univerjs/network';
+import { IBeforeCloseService, IMessageService, INotificationService } from '@univerjs/ui';
+import { ICombResponseEvent } from '@univerjs-pro/collaboration';
+import { ICollaborationSocket, ICollaborationSocketService } from '@univerjs-pro/collaboration-client';
+import { Subject } from 'rxjs';
+/**
+ * The handler object for a mocked socket connection. You can terminate, send messages / error through this object.
+ */
+export interface IMockCollabSessionSocketHandler extends ICollaborationSocket {
+    socket: ICollaborationSocket;
+    close$: Subject<CloseEvent>;
+    error$: Subject<Event>;
+    open$: Subject<Event>;
+    message$: Subject<ICombResponseEvent>;
+}
+/**
+ * This service provides a mocked
+ */
+export declare class MockCollaborationSocketService implements ICollaborationSocketService {
+    private readonly _logService;
+    private readonly _handlers;
+    constructor(_logService: ILogService);
+    createSocket(url: string): Nullable<ICollaborationSocket>;
+    /** Test scripts could get the session handler from this method to mock network events. */
+    getHandler(url: string): Nullable<IMockCollabSessionSocketHandler>;
+}
+export declare class MockBeforeCloseService implements IBeforeCloseService {
+    private _onCloseCallbacks;
+    private _beforeCloseCallbacks;
+    registerBeforeClose(callback: () => string | undefined): IDisposable;
+    registerOnClose(callback: () => void): IDisposable;
+}
+/**
+ * A mocked local storage service which use in-memory storage.
+ */
+export declare class MockLocalStorageService implements ILocalStorageService {
+    private readonly _inMemoryCache;
+    getItem<T>(key: string): Promise<T | null>;
+    setItem<T>(key: string, value: T): Promise<T>;
+    removeItem(_key: string): Promise<void>;
+    clear(): Promise<void>;
+    key(_index: number): Promise<string | null>;
+    keys(): Promise<string[]>;
+    iterate<T, U>(_iteratee: (value: T, key: string, iterationNumber: number) => U): Promise<U>;
+}
+export declare class MockMessageService implements IMessageService {
+    show(_options: IMessageOptions & Omit<IMessageProps, 'key'>): IDisposable;
+    setContainer(_container: HTMLElement): void;
+    getContainer(): HTMLElement;
+}
+export declare class MockNotificationService implements INotificationService {
+    show(): IDisposable;
+}
+export declare class MockHTTPService {
+    get(url: string): Promise<HTTPResponse<any>>;
+}

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

@@ -0,0 +1,17 @@
+import { CollaborationUIEventService, ILocalCacheService } from '@univerjs-pro/collaboration-client';
+import { Disposable, LocaleService } from '@univerjs/core';
+import { IBeforeCloseService, IMessageService, INotificationService } from '@univerjs/ui';
+/**
+ * This controller is responsible for the general UI of the collaboration client.
+ */
+export declare class CollaborationClientUIController extends Disposable {
+    private readonly _beforeCloseService;
+    protected readonly _localCacheService: ILocalCacheService;
+    private readonly _collaborationUIEventService;
+    protected readonly _messageService: IMessageService;
+    private readonly _notificationService;
+    protected readonly _localeService: LocaleService;
+    constructor(_beforeCloseService: IBeforeCloseService, _localCacheService: ILocalCacheService, _collaborationUIEventService: CollaborationUIEventService, _messageService: IMessageService, _notificationService: INotificationService, _localeService: LocaleService);
+    private _setupBeforeClosingHandler;
+    private _initEvent;
+}

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

@@ -0,0 +1,10 @@
+import { DependencyOverride } from '@univerjs/core';
+export declare const PLUGIN_CONFIG_KEY = "collaboration-client-ui.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverCollaborationClientUIConfig {
+    /**
+     * Override internal modules with custom implementations.
+     */
+    override?: DependencyOverride;
+}
+export declare const defaultPluginConfig: IUniverCollaborationClientUIConfig;

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

@@ -0,0 +1,25 @@
+import { Disposable, LocaleService } from '@univerjs/core';
+import { DocStateChangeManagerService } from '@univerjs/docs-ui';
+import { IMessageService } from '@univerjs/ui';
+import { CollaborationController, CollaborationStatus } from '@univerjs-pro/collaboration-client';
+import { BehaviorSubject } from 'rxjs';
+import { DocTransformIMECacheService } from '../../services/ime-cache-transform/doc-transform-ime-cache.service';
+import { DocTransformStateCacheService } from '../../services/state-cache-transform/doc-transform-state-cache.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';
+/**
+ * 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;
+    private readonly _docTransformSelectionsService;
+    private readonly _docSyncEditingCollabCursorService;
+    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);
+    private _initEntityListener;
+}

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

@@ -0,0 +1 @@
+export {};

package/lib/types/controllers/url/web-url.controller.d.ts

@@ -0,0 +1,18 @@
+import { DataLoaderService } from '@univerjs-pro/collaboration-client';
+import { ICommandService, ILogService, RxDisposable } from '@univerjs/core';
+import { IRemoteInstanceService } from '@univerjs/rpc';
+import { IURLService } from '../../services/url/url.service';
+/**
+ * This controller loads data when URL changes.
+ */
+export declare class WebUrlController extends RxDisposable {
+    private readonly _urlService;
+    private readonly _logService;
+    private readonly _commandService;
+    private readonly _dataLoaderService;
+    constructor(_urlService: IURLService, _logService: ILogService, _commandService: ICommandService, _dataLoaderService: DataLoaderService, remoteInstanceService?: IRemoteInstanceService);
+    private _init;
+    private _setupSubUnitSync;
+    private _updateURLWithCurrentState;
+    private _updateSubUnitFromURLParams;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,6 @@
+export { UniverCollaborationClientUIPlugin } from './plugin';
+export { DesktopCollaborationStatusDisplayController } from './controllers/collab-status/collab-status.controller';
+/** @deprecated Will be removed in the 0.2.19 release */
+export { CollaborationStatusDisplay } from './views/components/CollabStatus';
+export { WebBrowserSingleActiveUnitService } from './services/single-active-unit/single-active-unit.service';
+export { type ISheetCollabCursorShapeProps, SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/fa-IR.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/fr-FR.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,39 @@
+declare const locales: {
+    'collab-client': {
+        tooltip: {
+            reconnect: string;
+        };
+    };
+    collabStatus: {
+        fetchMiss: string;
+        conflict: string;
+        notCollab: string;
+        synced: string;
+        syncing: string;
+        offline: string;
+    };
+    session: {
+        'connection-failed': string;
+        'will-retry': string;
+        'room-full': string;
+        'collaboration-timeout': string;
+    };
+    conflict: {
+        title: string;
+        content: string;
+    };
+    permission: {
+        title: string;
+        content: string;
+    };
+    collaboration: {
+        'single-unit': {
+            warning: string;
+        };
+        closeRoom: string;
+    };
+    auth: {
+        needGotoLoginAlert: string;
+    };
+};
+export default locales;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

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

@@ -0,0 +1,30 @@
+import { IRange } from '@univerjs/core';
+import { ITextRangeWithStyle } from '@univerjs/engine-render';
+/**
+ * The data structure to store collab cursor info of sheet.
+ */
+export interface ISheetCollabCursor {
+    /** Stroke color of this collab cursor */
+    color: string;
+    /** Position of this cursor */
+    range: IRange;
+    /** Displayed user name of this cursor */
+    name: string;
+    /** The serialized range to check if two cursor are on the same position. */
+    selection: string;
+    /** Worksheet ID */
+    sheetID: string;
+    /** Background color of this collab cursor */
+    backgroundColor?: string;
+}
+/**
+ * The data structure to store collab cursor info of doc.
+ */
+export interface IDocCollabCursor {
+    /** Background color of this collab cursor */
+    color: string;
+    /** Displayed user name of this cursor */
+    name: string;
+    /** The deserialized ranges of collab cursor. */
+    ranges: ITextRangeWithStyle[];
+}

package/lib/types/plugin.d.ts

@@ -0,0 +1,17 @@
+import { IUniverCollaborationClientUIConfig } from './controllers/config.schema';
+import { IConfigService, ILogService, Injector, Plugin } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+export declare class UniverCollaborationClientUIPlugin extends Plugin {
+    private readonly _config;
+    private readonly _logService;
+    private readonly _renderManagerService;
+    protected _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    constructor(_config: Partial<IUniverCollaborationClientUIConfig> | undefined, _logService: ILogService, _renderManagerService: IRenderManagerService, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onRendered(): void;
+    private _registerDependencies;
+    private _registerRenderDependencies;
+    private _initDependencies;
+}

package/lib/types/services/color-assign/color-assign.service.d.ts

@@ -0,0 +1,10 @@
+import { Disposable } from '@univerjs/core';
+export declare const BACKGROUND_TOKENS: string[];
+/**
+ * This service assign a color to each collaboration member.
+ */
+export declare class ColorAssignService extends Disposable {
+    private _assignedColors;
+    private _colorIndex;
+    assignAColorForMemberID(memberID: string): string;
+}

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

@@ -0,0 +1,13 @@
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
+import { Injector } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+export declare class DocTransformIMECacheService {
+    private readonly _injector;
+    private readonly _transformService;
+    private readonly _renderManagerService;
+    constructor(_injector: Injector, _transformService: ITransformService, _renderManagerService: IRenderManagerService);
+    transformIMECache(changeset: IChangeset): void;
+    transformRemoteChangeset(changeset: IChangeset): IChangeset;
+    private _transformUndoRedoStack;
+    private _transformPreviousActiveRange;
+}

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

@@ -0,0 +1,27 @@
+import { UniverType } from '@univerjs/protocol';
+import { IChangeset, RevisionService } from '@univerjs-pro/collaboration';
+import { ILocalCacheService, IUnitCacheData } from '@univerjs-pro/collaboration-client';
+import { Disposable, IConfigService, ILocalStorageService, IMutationInfo, Nullable } from '@univerjs/core';
+/**
+ * This service provide caching to the collaboration controller.
+ */
+export declare class WebLocalCacheService extends Disposable implements ILocalCacheService {
+    private readonly _configService;
+    private readonly _localStorageService;
+    private readonly _revisionService;
+    private _cachedData;
+    private _saveTaskMap;
+    private _disabled;
+    constructor(_configService: IConfigService, _localStorageService: ILocalStorageService, _revisionService: RevisionService);
+    disableLocalCache(): void;
+    enableLocalCache(): void;
+    get saveTaskMap(): Map<string, number>;
+    dispose(): void;
+    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;
+    exhaustSavingTask(): Promise<void>;
+}

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

@@ -0,0 +1,26 @@
+import { ISingleActiveUnitService, UnitStatus } from '@univerjs-pro/collaboration-client';
+import { Observable } from 'rxjs';
+import { Disposable } from '@univerjs/core';
+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/state-cache-transform/doc-transform-state-cache.service.d.ts

@@ -0,0 +1,12 @@
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
+import { Injector } from '@univerjs/core';
+import { DocStateChangeManagerService } from '@univerjs/docs-ui';
+export declare class DocTransformStateCacheService {
+    private readonly _injector;
+    private readonly _transformService;
+    private readonly _docStateChangeManagerService;
+    constructor(_injector: Injector, _transformService: ITransformService, _docStateChangeManagerService: DocStateChangeManagerService);
+    transformStateCache(changeset: IChangeset): void;
+    transformRemoteChangeset(changeset: IChangeset): IChangeset;
+    private _transformHistoryAndStateStack;
+}

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

@@ -0,0 +1,13 @@
+import { Nullable, RxDisposable } from '@univerjs/core';
+import { ITextRangeWithStyle } from '@univerjs/engine-render';
+import { IUpdateCursor } from '@univerjs/protocol';
+export interface ICollabEditingCursor {
+    unitID: string;
+    memberID: string;
+    textRanges: ITextRangeWithStyle[];
+}
+export declare class DocSyncEditingCollabCursorService extends RxDisposable {
+    private readonly _collabCursorState$;
+    readonly collabCursorState$: import('rxjs').Observable<Nullable<IUpdateCursor>>;
+    syncEditingCollabCursor(collabCursor: ICollabEditingCursor): void;
+}

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

@@ -0,0 +1,8 @@
+import { Injector } from '@univerjs/core';
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
+export declare class DocTransformSelectionsService {
+    private readonly _injector;
+    private readonly _transformService;
+    constructor(_injector: Injector, _transformService: ITransformService);
+    transformSelections(changeset: IChangeset): void;
+}

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

@@ -0,0 +1,12 @@
+import { Observable } from 'rxjs';
+/**
+ * This service reads the url from the host platform and return url parts,
+ * such as queries, hashes and path.
+ */
+export interface IURLService {
+    getParam: (key: string) => string | undefined;
+    setParam: (key: string, value: string, useReplace?: boolean) => void;
+    removeParam: (key: string, useReplace?: boolean) => void;
+    urlChange$: Observable<void>;
+}
+export declare const IURLService: import('@wendellhu/redi').IdentifierDecorator<IURLService>;

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

@@ -0,0 +1,10 @@
+import { Observable } from 'rxjs';
+import { IURLService } from './url.service';
+import { RxDisposable } from '@univerjs/core';
+export declare class WebURLService extends RxDisposable implements IURLService {
+    readonly urlChange$: Observable<void>;
+    constructor();
+    setParam(key: string, value: string, useReplace?: boolean): void;
+    removeParam(key: string, useReplace?: boolean): void;
+    getParam(key: string): string | undefined;
+}

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

@@ -0,0 +1,10 @@
+import { Observable } from 'rxjs';
+import { CollaborationStatus } from '@univerjs-pro/collaboration-client';
+export interface IOnlineStatusProps {
+    /** The collaboration state of the currently focused unit. */
+    status$: Observable<CollaborationStatus>;
+}
+/**
+ * A component to display collaboration status to users.
+ */
+export declare function CollaborationStatusDisplay(props: Readonly<IOnlineStatusProps>): JSX.Element;

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

@@ -0,0 +1,8 @@
+import { Meta } from '@storybook/react';
+import { default as React } from 'react';
+import { CollaborationStatusDisplay } from './CollabStatus';
+declare const meta: Meta<typeof CollaborationStatusDisplay>;
+export default meta;
+export declare const Playground: {
+    render: () => React.JSX.Element;
+};

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

@@ -0,0 +1,27 @@
+import { Documents, DocumentSkeleton, Scene } from '@univerjs/engine-render';
+import { IDocCollabCursor } from '../../models/cursor';
+/**
+ * Render a single collaborated cursor on the canvas.
+ */
+export declare class DocCollabCursor {
+    private _cursor;
+    private _scene;
+    private _docSkeleton;
+    private _document;
+    private _shapes;
+    private _anchor;
+    private _textBubble;
+    private _anchorDot;
+    private _hideTimer;
+    private _eventUnsubscribe;
+    constructor(_cursor: IDocCollabCursor, _scene: Scene, _docSkeleton: DocumentSkeleton, _document: Documents);
+    private set _hover(value);
+    dispose(): void;
+    private _render;
+    private _drawAnchor;
+    private _handleHover;
+    private _drawTextRange;
+    private _drawRectRange;
+    private _getAnchorBounding;
+    private _getScale;
+}

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

@@ -0,0 +1,27 @@
+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;
+export interface ISheetCollabCursorShapeProps extends IShapeProps, ISheetCollabCursor {
+    hovered?: boolean;
+    labelPosition?: 'bottom' | 'top';
+}
+/**
+ * Render a single collaborated cursor on the canvas.
+ */
+export declare class SheetCollabCursorShape<T extends ISheetCollabCursorShapeProps = ISheetCollabCursorShapeProps> extends Shape<T> {
+    private _color;
+    private _hovered;
+    private _range;
+    private _name;
+    private _labelPosition;
+    private _backgroundColor?;
+    constructor(key?: string, props?: T);
+    setShapeProps(props: Partial<ISheetCollabCursorShapeProps>): void;
+    onMouseMove(position: {
+        row: number;
+        column: number;
+    }): void;
+    triggerDblclick(evt: IPointerEvent | IMouseEvent): boolean;
+    protected _draw(ctx: CanvasRenderingContext2D): void;
+}

package/lib/types/views/shapes/text-bubble.shape.d.ts

@@ -0,0 +1,19 @@
+import { IShapeProps, UniverRenderingContext, Shape } from '@univerjs/engine-render';
+export declare const COLLAB_CURSOR_LABEL_HEIGHT = 20;
+export declare const COLLAB_CURSOR_LABEL_MAX_WIDTH = 200;
+export declare const COLLAB_CURSOR_LABEL_TEXT_PADDING_LR = 4;
+export declare const COLLAB_CURSOR_LABEL_TEXT_PADDING_TB = 5;
+export interface ITextBubbleShapeProps extends IShapeProps {
+    color: string;
+    text: string;
+}
+/**
+ * Render a single collaborated cursor on the canvas.
+ */
+export declare class TextBubbleShape<T extends ITextBubbleShapeProps = ITextBubbleShapeProps> extends Shape<T> {
+    color: string;
+    text: string;
+    constructor(key: string, props: T);
+    static drawWith(ctx: CanvasRenderingContext2D, props: ITextBubbleShapeProps): void;
+    protected _draw(ctx: UniverRenderingContext): void;
+}