@univerjs-pro/collaboration-client 0.1.11 → 0.1.13

package/lib/locale/en-US.json

@@ -0,0 +1,32 @@
+{
+  "collabStatus": {
+    "fetchMiss": "Syncing server data...",
+    "conflict": "Edit conflicts",
+    "notCollab": "Local file",
+    "synced": "Synced",
+    "syncing": "Syncing...",
+    "offline": "Offline, edits would be save on local"
+  },
+  "session": {
+    "connection-failed": "Connection failed, please check your network.",
+    "will-retry": "Connection failed, we retry in a while.",
+    "room-full": "Collaboration room is full. You edits would be saved locally.",
+    "collaboration-timeout": "The server is not responding to your collaboration request. Your edits would be saved locally."
+  },
+  "conflict": {
+    "title": "Collaboration Conflict",
+    "content": "There is a conflict between your local copy and the copy on the server. Please save your local edits, because they will be lost when you reload the page."
+  },
+  "permission": {
+    "title": "Authentication Error",
+    "content": "Your actions are conflicting with the server's permissions. Please save your local edits elsewhere as they will be discarded after refreshing the page."
+  },
+  "collaboration": {
+    "single-unit": {
+      "warning": "You opened the same file in another tab. In case of data missing, you cannot edit on this tab."
+    }
+  },
+  "auth": {
+    "needGotoLoginAlert": "Your login has expired, click OK to re-login, click Cancel to save your local edits."
+  }
+}

package/lib/locale/ru-RU.json

@@ -0,0 +1,32 @@
+{
+  "collabStatus": {
+    "fetchMiss": "Syncing server data...",
+    "conflict": "Edit conflicts",
+    "notCollab": "Local file",
+    "synced": "Synced",
+    "syncing": "Syncing...",
+    "offline": "Offline, edits would be save on local"
+  },
+  "session": {
+    "connection-failed": "Connection failed, please check your network.",
+    "will-retry": "Connection failed, we retry in a while.",
+    "room-full": "Collaboration room is full. You edits would be saved locally.",
+    "collaboration-timeout": "The server is not responding to your collaboration request. Your edits would be saved locally."
+  },
+  "conflict": {
+    "title": "Collaboration Conflict",
+    "content": "There is a conflict between your local copy and the copy on the server. Please save your local edits, because they will be lost when you reload the page."
+  },
+  "permission": {
+    "title": "Authentication Error",
+    "content": "Your actions are conflicting with the server's permissions. Please save your local edits elsewhere as they will be discarded after refreshing the page."
+  },
+  "collaboration": {
+    "single-unit": {
+      "warning": "You opened the same file in another tab. In case of data missing, you cannot edit on this tab."
+    }
+  },
+  "auth": {
+    "needGotoLoginAlert": "Your login has expired, click OK to re-login, click Cancel to save your local edits."
+  }
+}

package/lib/locale/zh-CN.json

@@ -0,0 +1,32 @@
+{
+  "collabStatus": {
+    "fetchMiss": "正在同步服务端数据...",
+    "conflict": "编辑冲突",
+    "notCollab": "本地文件",
+    "synced": "已保存",
+    "syncing": "保存中...",
+    "offline": "编辑将在本地保存"
+  },
+  "session": {
+    "connection-failed": "连接失败，请检查你的网络",
+    "will-retry": "连接失败，将在一会儿之后重试",
+    "room-full": "协同房间已满，你的编辑将在本地保存",
+    "collaboration-timeout": "服务器未响应你的协同请求，你的编辑将在本地保存"
+  },
+  "conflict": {
+    "title": "协同冲突",
+    "content": "你的本地文档和服务器的文档存在冲突。请在别处保存你的本地编辑，本地编辑将在刷新页面后丢弃。"
+  },
+  "permission": {
+    "title": "权限错误",
+    "content": "你的操作和服务器的权限存在冲突。请在别处保存你的本地编辑，本地编辑将在刷新页面后丢弃。"
+  },
+  "collaboration": {
+    "single-unit": {
+      "warning": "你在另一个标签页打开了同一个文件。为了避免数据丢失，这个标签页的编辑行为将会被限制。"
+    }
+  },
+  "auth": {
+    "needGotoLoginAlert": "你的登录已过期，点击确认重新登陆，点击取消去保存你的本地编辑。"
+  }
+}

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

@@ -1,18 +1,20 @@
 import { Disposable, IUniverInstanceService } from '@univerjs/core';
-import { IDesktopUIController } from '@univerjs/ui';
+import { IUIPartsService } from '@univerjs/ui';
 import { Injector } from '@wendellhu/redi';
+import { BehaviorSubject } from 'rxjs';
 import { CollaborationController } from '../collaboration/collaboration.controller';
+import { CollaborationStatus } from '../collaboration/collaboration-state';
 
 /**
  * This controller is responsible for monitoring the collaboration status of the currently focused unit.
  */
 export declare class DesktopCollaborationStatusDisplayController extends Disposable {
-    private readonly _uiController;
     private readonly _univerInstanceService;
+    private readonly _uiPartsService;
     private readonly _injector;
     private readonly _collaborationController;
-    private readonly _status$;
-    constructor(_uiController: IDesktopUIController, _univerInstanceService: IUniverInstanceService, _injector: Injector, _collaborationController: CollaborationController);
-    private _mountOnlineHint;
+    protected readonly _status$: BehaviorSubject<CollaborationStatus>;
+    constructor(_univerInstanceService: IUniverInstanceService, _uiPartsService: IUIPartsService, _injector: Injector, _collaborationController: CollaborationController);
+    protected _initStatusComponent(): void;
     private _initStatusListener;
 }

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

@@ -1,5 +1,5 @@
 import { ILocalStorageService, Nullable, ILogService } from '@univerjs/core';
-import { IMessageMethodOptions, IMessageProps } from '@univerjs/design';
+import { IMessageOptions, IMessageProps } from '@univerjs/design';
 import { IBeforeCloseService, IMessageService, INotificationService } from '@univerjs/ui';
 import { ICombResponseEvent } from '@univerjs-pro/collaboration';
 import { IDisposable } from '@wendellhu/redi';
@@ -47,7 +47,7 @@ export declare class MockLocalStorageService implements ILocalStorageService {
     iterate<T, U>(_iteratee: (value: T, key: string, iterationNumber: number) => U): Promise<U>;
 }
 export declare class MockMessageService implements IMessageService {
-    show(_options: IMessageMethodOptions & Omit<IMessageProps, 'key'>): IDisposable;
+    show(_options: IMessageOptions & Omit<IMessageProps, 'key'>): IDisposable;
     setContainer(_container: HTMLElement): void;
 }
 export declare class MockNotificationService implements INotificationService {

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

@@ -1,4 +1,4 @@
-import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, IUniverInstanceService, LocaleService, UniverPermissionService } from '@univerjs/core';
+import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { INotificationService } from '@univerjs/ui';
 import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
 import { UniverType } from '@univerjs/protocol';
@@ -83,7 +83,9 @@ export declare abstract class CollaborationState {
     /**
      * Received a rejection from the server, meaning that conflict could be resolved by the algorithm.
      */
-    abstract onRemoteRej(): CollaborationState;
+    abstract onRemoteRej(config?: {
+        isPermissionRej: boolean;
+    }): CollaborationState;
     abstract toggleOffline(): CollaborationState;
     abstract toggleOnline(): CollaborationState;
     /**
@@ -168,7 +170,9 @@ export declare class AwaitingState extends CollaborationState {
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(changeset: IAcknowledgedChangeset): CollaborationState;
-    onRemoteRej(): CollaborationState;
+    onRemoteRej(config?: {
+        isPermissionRej: boolean;
+    }): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -187,7 +191,9 @@ export declare class AwaitingWithPendingState extends CollaborationState {
     appendMutation(mutation: IMutationInfo): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
     onRemoteAck(changeset: IAcknowledgedChangeset): CollaborationState;
-    onRemoteRej(): CollaborationState;
+    onRemoteRej(config?: {
+        isPermissionRej: boolean;
+    }): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     resend(): void;
@@ -200,11 +206,12 @@ export declare class AwaitingWithPendingState extends CollaborationState {
  * reload the document.
  */
 export declare class ConflictState extends CollaborationState {
-    private readonly _univerPermissionService;
+    private _isPermissionRej;
+    private readonly _permissionService;
     private readonly _localeService;
     private readonly _notificationService;
     readonly status = CollaborationStatus.CONFLICT;
-    constructor(unitID: string, type: UniverType, awaitingChangeset: Nullable<IChangeset>, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, _univerPermissionService: UniverPermissionService, commandService: ICommandService, undoRedoService: ICollaborativeUndoRedoService, localCacheService: LocalCacheService, revisionService: RevisionService, _localeService: LocaleService, _notificationService: INotificationService);
+    constructor(unitID: string, type: UniverType, awaitingChangeset: Nullable<IChangeset>, pendingMutations: IMutationInfo[], handler: ICollaborationStateHandler, _isPermissionRej: boolean, _permissionService: IPermissionService, commandService: ICommandService, undoRedoService: ICollaborativeUndoRedoService, localCacheService: LocalCacheService, revisionService: RevisionService, _localeService: LocaleService, _notificationService: INotificationService);
     appendMutation(): CollaborationState;
     onRemoteChangeset(): CollaborationState;
     onRemoteAck(): CollaborationState;
@@ -257,8 +264,10 @@ export declare class FetchingMissState extends CollaborationState {
     resend(): void;
     appendMutation(mutation: IMutationInfo<object>): CollaborationState;
     onRemoteChangeset(changeset: IChangeset): CollaborationState;
-    onRemoteAck(changeset: IAcknowledgedChangeset): CollaborationState;
-    onRemoteRej(): CollaborationState;
+    onRemoteAck(_changeset: IAcknowledgedChangeset): CollaborationState;
+    onRemoteRej(config?: {
+        isPermissionRej: boolean;
+    }): CollaborationState;
     toggleOffline(): CollaborationState;
     toggleOnline(): CollaborationState;
     private _onConflict;

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

@@ -1,4 +1,4 @@
-import { IMutationInfo, Nullable, ICommandService, ILogService, IUniverInstanceService, LocaleService, RxDisposable, UniverPermissionService } from '@univerjs/core';
+import { IMutationInfo, Nullable, ICommandService, ILogService, IPermissionService, IUniverInstanceService, LocaleService, RxDisposable } from '@univerjs/core';
 import { IMessageService } from '@univerjs/ui';
 import { CompressMutationService, RevisionService } from '@univerjs-pro/collaboration';
 import { UniverType } from '@univerjs/protocol';
@@ -43,13 +43,13 @@ export declare abstract class CollaborationEntity extends RxDisposable {
     protected readonly _session: CollaborationSession;
     protected readonly _injector: Injector;
     protected readonly _localCacheService: LocalCacheService;
-    protected readonly _univerPermissionService: UniverPermissionService;
     protected readonly _compressMutationService: CompressMutationService;
     protected readonly _localeService: LocaleService;
     protected readonly _revisionService: RevisionService;
     protected readonly _logService: ILogService;
     protected readonly _commandService: ICommandService;
     protected readonly _messageService: IMessageService;
+    private _permissionService;
     protected readonly _singleActiveUnitService?: ISingleActiveUnitService | undefined;
     protected _state$: BehaviorSubject<Nullable<CollaborationState>>;
     readonly state$: Observable<Nullable<CollaborationState>>;
@@ -57,7 +57,7 @@ export declare abstract class CollaborationEntity extends RxDisposable {
     get state(): CollaborationState;
     protected _collaborationPaused: boolean;
     readonly status$: Observable<CollaborationStatus>;
-    constructor(unitID: string, _type: UniverType, _session: CollaborationSession, _injector: Injector, _localCacheService: LocalCacheService, _univerPermissionService: UniverPermissionService, _compressMutationService: CompressMutationService, _localeService: LocaleService, _revisionService: RevisionService, _logService: ILogService, _commandService: ICommandService, _messageService: IMessageService, _singleActiveUnitService?: ISingleActiveUnitService | undefined);
+    constructor(unitID: string, _type: UniverType, _session: CollaborationSession, _injector: Injector, _localCacheService: LocalCacheService, _compressMutationService: CompressMutationService, _localeService: LocaleService, _revisionService: RevisionService, _logService: ILogService, _commandService: ICommandService, _messageService: IMessageService, _permissionService: IPermissionService, _singleActiveUnitService?: ISingleActiveUnitService | undefined);
     init(): Promise<void>;
     /**
      * Pause collaboration on the document. Remote changesets would be inserted to a queue and wait for resuming.
@@ -95,7 +95,7 @@ export declare class DocCollaborationEntity extends CollaborationEntity {
     private readonly _docTransformIMECacheService;
     private readonly _docTransformSelectionsService;
     private readonly _docSyncEditingCollabCursorService;
-    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, univerPermissionService: UniverPermissionService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _docStateChangeManagerService: DocStateChangeManagerService, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, singleActiveUnitService?: ISingleActiveUnitService);
+    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _docStateChangeManagerService: DocStateChangeManagerService, _docTransformIMECacheService: DocTransformIMECacheService, _docTransformSelectionsService: DocTransformSelectionsService, _docSyncEditingCollabCursorService: DocSyncEditingCollabCursorService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, permissionService: IPermissionService, singleActiveUnitService?: ISingleActiveUnitService);
     protected _createHandler(): ICollaborationStateHandler;
     protected _init(): Promise<CollaborationState>;
 }
@@ -104,7 +104,7 @@ export declare class SheetCollaborationEntity extends CollaborationEntity {
     readonly type: UniverType;
     readonly session: CollaborationSession;
     private readonly _sheetTransformSelectionsService;
-    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, univerPermissionService: UniverPermissionService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _sheetTransformSelectionsService: SheetTransformSelectionsService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, singleActiveUnitService?: ISingleActiveUnitService);
+    constructor(unitID: string, type: UniverType, session: CollaborationSession, injector: Injector, localCacheService: LocalCacheService, compressMutationService: CompressMutationService, localeService: LocaleService, revisionService: RevisionService, _sheetTransformSelectionsService: SheetTransformSelectionsService, logService: ILogService, commandService: ICommandService, messageService: IMessageService, permissionService: IPermissionService, singleActiveUnitService?: ISingleActiveUnitService);
     protected _createHandler(): ICollaborationStateHandler;
     protected _init(): Promise<CollaborationState>;
 }

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
 export { CollaborationController } from './controllers/collaboration/collaboration.controller';
-export { SEND_CHANGESET_TIMEOUT_KEY } from './controllers/collaboration/collaboration-state';
+export { SEND_CHANGESET_TIMEOUT_KEY, CollaborationStatus, } from './controllers/collaboration/collaboration-state';
 export { CollaborationClientPlugin, type ICollaborationClientPluginConfig } from './plugin';
 export { COLLAB_WEB_SOCKET_URL_KEY, CollaborationSession, CollaborationSessionService, HEARTBEAT_INTERVAL_KEY, HEARTBEAT_TIMEOUT_KEY, SessionStatus, } from './services/collaboration-session/collaboration-session.service';
 export { LOCAL_CACHE_INTERVAL_KEY } from './services/local-cache/local-cache.service';
@@ -10,6 +10,8 @@ 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 { DesktopCollaborationStatusDisplayController } from './controllers/collab-status/collab-status.controller';
 export { LOGIN_URL_KEY } from './services/auth-server/auth-server.service';
+export { AuthzIoHttpService } from './services/auth-server/authz-io-http.service';
 export { deserializeToCombResponse, serializeCombRequest } from './services/socket/serialize';
-export { enUS, zhCN } from './locale';
+export { CollaborationStatusDisplay } from './views/components/CollabStatus';

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

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

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

@@ -17,6 +17,10 @@ declare const locales: {
         title: string;
         content: string;
     };
+    permission: {
+        title: string;
+        content: string;
+    };
     collaboration: {
         'single-unit': {
             warning: string;

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

@@ -0,0 +1,29 @@
+import { IAuthzIoService, IConfigService } from '@univerjs/core';
+import { HTTPService } from '@univerjs/network';
+import { IActionInfo, IAllowedRequest, IBatchAllowedResponse, ICollaborator, ICreateCollaboratorRequest, ICreateRequest, IDeleteCollaboratorRequest, IListCollaboratorRequest, IListPermPointRequest, IListPermPointResponse, IListRolesRequest, IPutCollaboratorsRequest, IUnitRoleKV, IUpdateCollaboratorRequest, IUpdatePermPointRequest, UnitAction } from '@univerjs/protocol';
+
+/**
+ * The config key to determined the URL provided by the author server.
+ * The URL should not ends with a slash.
+ */
+export declare const AUTHZ_URL_KEY = "AUTHZ_URL_KEY";
+export declare class AuthzIoHttpService implements IAuthzIoService {
+    private _HTTPService;
+    private _configService;
+    constructor(_HTTPService: HTTPService, _configService: IConfigService);
+    private _getAPIPrefixPath;
+    create(config: ICreateRequest): Promise<string>;
+    list(config: IListPermPointRequest): Promise<IListPermPointResponse['objects']>;
+    update(config: IUpdatePermPointRequest): Promise<void>;
+    allowed(config: IAllowedRequest): Promise<IActionInfo[]>;
+    batchAllowed(config: IAllowedRequest[]): Promise<IBatchAllowedResponse['objectActions']>;
+    listRoles(config: IListRolesRequest): Promise<{
+        roles: IUnitRoleKV[];
+        actions: UnitAction[];
+    }>;
+    deleteCollaborator(config: IDeleteCollaboratorRequest): Promise<void>;
+    updateCollaborator(config: IUpdateCollaboratorRequest): Promise<void>;
+    createCollaborator(config: ICreateCollaboratorRequest): Promise<void>;
+    listCollaborators(config: IListCollaboratorRequest): Promise<ICollaborator[]>;
+    putCollaborators(config: IPutCollaboratorsRequest): Promise<void>;
+}

package/lib/types/services/image-remote/image-io.service.d.ts

@@ -0,0 +1,31 @@
+import { Nullable, IConfigService } from '@univerjs/core';
+import { IImageIoService, IImageIoServiceParam, ImageSourceType } from '@univerjs/drawing';
+import { HTTPService } from '@univerjs/network';
+import { IError } from '@univerjs/protocol';
+import { Observable } from 'rxjs';
+
+export declare const ALLOW_IMAGE_LIST: string[];
+export declare const EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY = "EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY";
+export declare const EXCHANGE_SIGN_URL_SERVER_URL_KEY = "EXCHANGE_SIGN_URL_SERVER_URL_KEY";
+export interface ISignUrlResponse {
+    error: IError | undefined;
+    url: string;
+}
+export declare class ImageIoService implements IImageIoService {
+    private readonly _httpService;
+    private readonly _configService;
+    private _waitCount;
+    private _change$;
+    change$: Observable<number>;
+    constructor(_httpService: HTTPService, _configService: IConfigService);
+    setWaitCount(count: number): void;
+    private _imageSourceCache;
+    getImageSourceCache(source: string, imageSourceType: ImageSourceType): HTMLImageElement | undefined;
+    addImageSourceCache(source: string, imageSourceType: ImageSourceType, imageSource: Nullable<HTMLImageElement>): void;
+    getImage(imageId: string): Promise<string>;
+    saveImage(imageFile: File): Promise<Nullable<IImageIoServiceParam>>;
+    private _getUploadFileURL;
+    private _getSignURL;
+    private _replaceFileID;
+    private _decreaseWaiting;
+}

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

@@ -7,8 +7,5 @@ export interface IOnlineStatusProps {
 }
 /**
  * A component to display collaboration status to users.
- *
- * @param props
- * @returns
  */
 export declare function CollaborationStatusDisplay(props: Readonly<IOnlineStatusProps>): JSX.Element;