@univerjs-pro/collaboration-client 0.5.1 → 0.5.2

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

@@ -1,22 +0,0 @@
-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 when URL changes.
- */
-export declare class DataLoaderController extends RxDisposable {
-    private _urlService;
-    private readonly _logService;
-    private readonly _commandService;
-    private readonly _localCacheService;
-    private readonly _snapshotService;
-    constructor(_urlService: IURLService, _logService: ILogService, _commandService: ICommandService, _localCacheService: LocalCacheService, _snapshotService: SnapshotService, remoteInstanceService?: IRemoteInstanceService);
-    private _init;
-    private _setupSubUnitSync;
-    private _updateURLWithCurrentState;
-    private _updateSubUnitFromURLParams;
-    private _loadSheet;
-    private _loadDoc;
-}

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

@@ -1,30 +0,0 @@
-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/services/color-assign/color-assign.service.d.ts

@@ -1,10 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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/state-cache-transform/doc-transform-state-cache.service.d.ts

@@ -1,12 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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;
-}