@univerjs-pro/collaboration-client 0.5.0-alpha.0 → 0.5.0-beta.0

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/undoredo/collaborative-undoredo.service.d.ts

@@ -0,0 +1,19 @@
+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.
+ */
+export interface ICollaborativeUndoRedoService extends IUndoRedoService {
+    transformUndoRedo: (unitID: string, changeset: IChangeset) => void;
+}
+export declare class CollaborativeUndoRedoService extends LocalUndoRedoService implements ICollaborativeUndoRedoService {
+    private readonly _transformService;
+    private readonly _logService;
+    constructor(_currentUniverSheet: IUniverInstanceService, _commandService: ICommandService, _contextService: IContextService, _transformService: ITransformService, _logService: ILogService);
+    transformUndoRedo(unitID: string, changesets: IChangeset): void;
+    private _clearUndo;
+    private _clearRedo;
+    private _substituteUndoStack;
+    private _substituteRedoStack;
+    private _transformStack;
+}

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 { 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>;
+    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 '../../controllers/collaboration/collaboration-state';
+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;
+}