@univerjs-pro/collaboration-client 0.2.14 → 0.3.0-alpha.0

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

@@ -2,6 +2,7 @@
  * The config key to determined the URL provided by the snapshot server
  * to load snapshot. The URL should not ends with a slash.
  */
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const SNAPSHOT_SERVER_URL_KEY = "SNAPSHOT_SERVER_URL_KEY";
 /**
  * Default value for `SNAPSHOT_SERVER_URL_KEY`.
@@ -16,8 +17,10 @@ export declare const SNAPSHOT_URL_KEY = "SNAPSHOT_URL_KEY";
 /**
  * Determines how often should we send changesets.
  */
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const SEND_CHANGESET_TIMEOUT_KEY = "SEND_CHANGESET_TIMEOUT";
 export declare const DEFAULT_SEND_CHANGESET_TIMEOUT = 2000;
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const COLLAB_WEB_SOCKET_URL_KEY = "COLLAB_WEB_SOCKET_URL";
 export declare const DEFAULT_COLLAB_WEB_SOCKET_URL = "ws://127.0.0.1:8000/universer-api/comb/connect";
 /** The heartbeat interval in milliseconds. */
@@ -25,7 +28,6 @@ export declare const HEARTBEAT_INTERVAL_KEY = "HEARTBEAT_INTERVAL";
 export declare const DEFAULT_HEARTBEAT_INTERVAL = 30000;
 export declare const HEARTBEAT_TIMEOUT_KEY = "HEARTBEAT_TIMEOUT";
 export declare const DEFAULT_HEARTBEAT_TIMEOUT = 20000;
-export declare const RETRY_CONNECTING_INTERVAL_KEY = "RETRY_CONNECTING_INTERVAL";
 export declare const DEFAULT_RETRY_CONNECTING_INTERVAL = 20000;
 export declare const RETRY_CONNECTING_MAX_COUNT_KEY = "RETRY_CONNECTING_MAX_COUNT";
 export declare const DEFAULT_RETRY_CONNECTING_MAX_COUNT = 3;
@@ -34,11 +36,13 @@ export declare const DEFAULT_RETRY_CONNECTING_MAX_COUNT = 3;
  */
 export declare const LOCAL_CACHE_INTERVAL_KEY = "LOCAL_CACHE_INTERVAL";
 export declare const LOCAL_CACHE_INTERVAL = 1000;
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const COLLAB_SUBMIT_CHANGESET_URL_KEY = "COLLAB_SUBMIT_CHANGESET_URL";
 /** The url prefix is determined by protocol in submodules/protocol/universer/v1/comb.proto */
 export declare const DEFAULT_COLLAB_SUBMIT_CHANGESET_URL = "/universer-api/comb";
 /**
  * The config key to determined the URL provided by the auth server
  */
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const LOGIN_URL_KEY = "LOGIN_URL_KEY";
 export declare const DEFAULT_LOGIN_URL = "/universer-api/oidc/authpage";

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

@@ -1,10 +1,10 @@
-import { ICommandService, Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
 import { ICollaborationUser, ITransformService } from '@univerjs-pro/collaboration';
 import { IDocCollabCursor } from '../../models/cursor';
+import { ICommandService, Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
 import { ColorAssignService } from '../../services/color-assign/color-assign.service';
 import { MemberService } from '../../services/member/member.service';
 import { DocSyncEditingCollabCursorService } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
-import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
 /**
  * Each univer document instance would map to an `CollabCursorEntity` to handle collaborated editing events.
  */

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

@@ -1,10 +1,10 @@
-import { ICommandService, Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
-import { RefRangeService } from '@univerjs/sheets';
 import { ICollaborationUser } from '@univerjs-pro/collaboration';
 import { ISheetCollabCursor } from '../../models/cursor';
+import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
+import { ICommandService, Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { RefRangeService } from '@univerjs/sheets';
 import { ColorAssignService } from '../../services/color-assign/color-assign.service';
 import { MemberService } from '../../services/member/member.service';
-import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
 /**
  * Each univer document instance would map to an `CollabCursorEntity` to handle collaborated editing events.
  */

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

@@ -1,18 +1,18 @@
-import { CompressMutationService, RevisionService } from '@univerjs-pro/collaboration';
 import { IDisposable, IMutationInfo, ICommandService, ILogService, Injector, IPermissionService, LocaleService, RxDisposable } from '@univerjs/core';
 import { UniverType } from '@univerjs/protocol';
-import { IMessageService } from '@univerjs/ui';
 import { Observable, BehaviorSubject } from 'rxjs';
 import { Nullable } from 'vitest';
+import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
+import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
 import { DocStateChangeManagerService } from '@univerjs/docs-ui';
+import { IMessageService } from '@univerjs/ui';
+import { CompressMutationService, RevisionService } from '@univerjs-pro/collaboration';
 import { DocTransformIMECacheService } from '../../services/ime-cache-transform/doc-transform-ime-cache.service';
 import { LocalCacheService } from '../../services/local-cache/local-cache.service';
 import { SheetTransformSelectionsService } from '../../services/range-selection/sheet-transform-selections.service';
 import { ISingleActiveUnitService } from '../../services/single-active-unit/single-active-unit.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';
-import { CollaborationSession } from '../../services/collaboration-session/collaboration-session';
-import { CollaborationState, ICollaborationStateHandler, CollaborationStatus } from './collaboration-state';
 /**
  * Each univer document instance would map to an `CollaborationEntity` to handle collaborated editing events.
  */

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

@@ -1,11 +1,11 @@
 import { IMutationInfo, Nullable, ICommandService, IConfigService, ILogService, Injector, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
-import { INotificationService } from '@univerjs/ui';
 import { IAcknowledgedChangeset, IChangeset, ITransformService, RevisionService } from '@univerjs-pro/collaboration';
+import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
+import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
 import { UniverType } from '@univerjs/protocol';
+import { INotificationService } from '@univerjs/ui';
 import { LocalCacheService } from '../../services/local-cache/local-cache.service';
 import { MemberService } from '../../services/member/member.service';
-import { ICollaborativeUndoRedoService } from '../../services/undoredo/collaborative-undoredo.service';
-import { ICollabEditingCursor } from '../../services/sync-editing-collab-cursor/doc-sync-editing-collab-cursor.service';
 /** Provide both states when and after changing, so the parent could examine if state transition is correct. */
 export type StateChangeHandler = (before: CollaborationState, after: CollaborationState) => void;
 /** A network interface to send changeset and  */

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

@@ -1,7 +1,7 @@
 import { Nullable, Injector, IUniverInstanceService, RxDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
-import { CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
 import { CollaborationEntity } from './collaboration-entity';
+import { CollaborationSessionService } from '../../services/collaboration-session/collaboration-session.service';
 export declare class CollaborationController extends RxDisposable {
     private readonly _injector;
     private readonly _collabSessionService;

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

@@ -1,5 +1,29 @@
+import { Ctor, DependencyOverride } from '@univerjs/core';
+import { ICollaborationSocketService } from '../services/socket/collaboration-socket.service';
 export declare const PLUGIN_CONFIG_KEY = "collaboration-client.config";
 export declare const configSymbol: unique symbol;
 export interface IUniverCollaborationClientConfig {
+    socketService?: Ctor<ICollaborationSocketService>;
+    enableOfflineEditing?: boolean;
+    enableSingleActiveInstanceLock?: boolean;
+    enableAuthServer?: boolean;
+    /**
+     * Override internal modules with custom implementations.
+     */
+    override?: DependencyOverride;
+    sendChangesetTimeout?: number;
+    snapshotServerUrl?: string;
+    collabSubmitChangesetUrl?: string;
+    collabWebSocketUrl?: string;
+    loginUrlKey?: string;
+    retryConnectingInterval?: number;
+    authzUrl?: string;
+    /**
+     * The URL of the endpoint for downloading files.
+     * @default 'location.origin'
+     */
+    downloadEndpointUrl?: string;
+    uploadFileServerUrl?: string;
+    signUrlServerUrl?: string;
 }
 export declare const defaultPluginConfig: IUniverCollaborationClientConfig;

package/lib/types/index.d.ts

@@ -1,8 +1,18 @@
-export { SNAPSHOT_SERVER_URL_KEY, SNAPSHOT_URL_KEY, SEND_CHANGESET_TIMEOUT_KEY, COLLAB_WEB_SOCKET_URL_KEY, HEARTBEAT_INTERVAL_KEY, HEARTBEAT_TIMEOUT_KEY, LOCAL_CACHE_INTERVAL_KEY, RETRY_CONNECTING_INTERVAL_KEY, RETRY_CONNECTING_MAX_COUNT_KEY, COLLAB_SUBMIT_CHANGESET_URL_KEY, LOGIN_URL_KEY, } from './config/config';
+export { 
+/** @deprecated Will be removed in the 0.2.19 release */
+COLLAB_SUBMIT_CHANGESET_URL_KEY, 
+/** @deprecated Will be removed in the 0.2.19 release */
+COLLAB_WEB_SOCKET_URL_KEY, HEARTBEAT_INTERVAL_KEY, HEARTBEAT_TIMEOUT_KEY, LOCAL_CACHE_INTERVAL_KEY, LOGIN_URL_KEY, RETRY_CONNECTING_MAX_COUNT_KEY, 
+/** @deprecated Will be removed in the 0.2.19 release */
+SEND_CHANGESET_TIMEOUT_KEY, 
+/** @deprecated Will be removed in the 0.2.19 release */
+SNAPSHOT_SERVER_URL_KEY, 
+/** @deprecated Will be removed in the 0.2.19 release */
+SNAPSHOT_URL_KEY, } from './config/config';
 export { CollaborationController } from './controllers/collaboration/collaboration.controller';
-export { CollaborationEntity, SheetCollaborationEntity, DocCollaborationEntity } from './controllers/collaboration/collaboration-entity';
+export { CollaborationEntity, DocCollaborationEntity, SheetCollaborationEntity } from './controllers/collaboration/collaboration-entity';
 export { CollaborationStatus } from './controllers/collaboration/collaboration-state';
-export { UniverCollaborationClientPlugin, type ICollaborationClientPluginConfig } from './plugin';
+export { UniverCollaborationClientPlugin } from './plugin';
 export { CollaborationSessionService } from './services/collaboration-session/collaboration-session.service';
 export { CollaborationSession, SessionStatus } from './services/collaboration-session/collaboration-session';
 export type { ICollaborationSocket } from './services/socket/collaboration-socket.service';
@@ -12,10 +22,12 @@ 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 { AUTHZ_URL_KEY, AuthzIoHttpService } from './services/auth-server/authz-io-http.service';
+export { AuthzIoHttpService } from './services/auth-server/authz-io-http.service';
+/** @deprecated Will be removed in the 0.2.19 release */
+export { AUTHZ_URL_KEY } from './services/auth-server/authz-io-http.service';
 export { deserializeToCombResponse, serializeCombRequest } from './services/socket/serialize';
 export { CollaborationStatusDisplay } from './views/components/CollabStatus';
 export { SnapshotServerOverHTTPService } from './services/snapshot-server/snapshot-server.service';
 export { CommentService } from './services/comment/comment.service';
-export { SheetCollabCursorShape, type ISheetCollabCursorShapeProps } from './views/shapes/sheet-collab-cursor.shape';
+export { type ISheetCollabCursorShapeProps, SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';
 export { ImageIoService } from './services/image-remote/image-io.service';

package/lib/types/plugin.d.ts

@@ -1,16 +1,6 @@
-import { Ctor, DependencyOverride, IConfigService, ILogService, Injector, Plugin } from '@univerjs/core';
+import { IUniverCollaborationClientConfig } from './controllers/config.schema';
+import { IConfigService, ILogService, Injector, Plugin } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
-import { ICollaborationSocketService } from './services/socket/collaboration-socket.service';
-export interface ICollaborationClientPluginConfig {
-    socketService?: Ctor<ICollaborationSocketService>;
-    enableOfflineEditing?: boolean;
-    enableSingleActiveInstanceLock?: boolean;
-    enableAuthServer?: boolean;
-    /**
-     * Override internal modules with custom implementations.
-     */
-    override?: DependencyOverride;
-}
 export declare class UniverCollaborationClientPlugin extends Plugin {
     private readonly _config;
     private readonly _logService;
@@ -18,7 +8,7 @@ export declare class UniverCollaborationClientPlugin extends Plugin {
     protected _injector: Injector;
     private readonly _configService;
     static pluginName: string;
-    constructor(_config: ICollaborationClientPluginConfig | undefined, _logService: ILogService, _renderManagerService: IRenderManagerService, _injector: Injector, _configService: IConfigService);
+    constructor(_config: Partial<IUniverCollaborationClientConfig> | undefined, _logService: ILogService, _renderManagerService: IRenderManagerService, _injector: Injector, _configService: IConfigService);
     onStarting(): void;
     onRendered(): void;
     private _registerDependencies;

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

@@ -1,10 +1,11 @@
 import { IAuthzIoService, Disposable, 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';
+import { HTTPService } from '@univerjs/network';
 /**
  * The config key to determined the URL provided by the author server.
  * The URL should not ends with a slash.
  */
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const AUTHZ_URL_KEY = "AUTHZ_URL_KEY";
 export declare class AuthzIoHttpService extends Disposable implements IAuthzIoService {
     private _HTTPService;

package/lib/types/services/auth-server/domain-request.service.d.ts

@@ -0,0 +1,6 @@
+import { HTTPService } from '@univerjs/network';
+export declare class DomainRequestService {
+    private readonly _httpService;
+    constructor(_httpService: HTTPService);
+    private _initRequestHeader;
+}

package/lib/types/services/collaboration-session/collaboration-session.service.d.ts

@@ -1,6 +1,6 @@
-import { Disposable, IConfigService, ILogService, Injector, LocaleService, Nullable } from '@univerjs/core';
+import { Nullable, Disposable, IConfigService, ILogService, Injector, LocaleService } from '@univerjs/core';
+import { ICollaborationSocket, ICollaborationSocketService } from '../socket/collaboration-socket.service';
 import { IMessageService } from '@univerjs/ui';
-import { ICollaborationSocketService, ICollaborationSocket } from '../socket/collaboration-socket.service';
 import { CollaborationSession, SessionStatus } from './collaboration-session';
 /**
  * This service provide collaboration sessions to univer instances. A collaboration session
@@ -27,6 +27,7 @@ export declare class CollaborationSessionService extends Disposable {
     private _retryConnectingTimer;
     private _retryCount;
     constructor(_injector: Injector, _localeService: LocaleService, _messageService: IMessageService, _logService: ILogService, _configService: IConfigService, _socketService: ICollaborationSocketService);
+    private _initEventListeners;
     dispose(): void;
     /**
      * Require a collaboration session.

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

@@ -1,10 +1,12 @@
 import { Nullable, IConfigService, IUniverInstanceService } from '@univerjs/core';
 import { IImageIoService, IImageIoServiceParam, ImageSourceType } from '@univerjs/drawing';
-import { HTTPService } from '@univerjs/network';
 import { IError } from '@univerjs/protocol';
 import { Observable } from 'rxjs';
+import { HTTPService } from '@univerjs/network';
 export declare const ALLOW_IMAGE_LIST: string[];
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY = "EXCHANGE_UPLOAD_FILE_SERVER_URL_KEY";
+/** @deprecated Will be removed in the 0.2.19 release */
 export declare const EXCHANGE_SIGN_URL_SERVER_URL_KEY = "EXCHANGE_SIGN_URL_SERVER_URL_KEY";
 export interface ISignUrlResponse {
     error: IError | undefined;
@@ -26,6 +28,7 @@ export declare class ImageIoService implements IImageIoService {
     saveImage(imageFile: File): Promise<Nullable<IImageIoServiceParam>>;
     private _getUploadFileURL;
     private _getSignURL;
+    private _getDownloadEndpointURL;
     private _replaceFileID;
     private _decreaseWaiting;
 }

package/lib/types/services/range-selection/sheet-transform-selections.service.d.ts

@@ -1,5 +1,5 @@
-import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 import { Injector, IUniverInstanceService } from '@univerjs/core';
+import { IChangeset, ITransformService } from '@univerjs-pro/collaboration';
 export declare function extractTargetFromFirstChangeset(changeset: IChangeset): {
     unitId: string;
     subUnitId: string;

package/lib/types/services/snapshot-server/snapshot-server.service.d.ts

@@ -1,13 +1,14 @@
+import { ICopyFileMetaResponse, IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetDeserializedSheetBlockResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetResponse, ISaveSheetBlockResponse, ISaveSnapshotResponse } from '@univerjs/protocol';
+import { ILogContext, ISnapshotServerService } from '@univerjs-pro/collaboration';
 import { IConfigService } from '@univerjs/core';
 import { HTTPService } from '@univerjs/network';
-import { IFetchMissingChangesetsRequest, IFetchMissingChangesetsResponse, IGetResourcesRequest, IGetResourcesResponse, IGetSheetBlockRequest, IGetSheetBlockResponse, IGetUnitOnRevRequest, IGetUnitOnRevResponse, ISaveChangesetResponse, ISaveSheetBlockResponse, ISaveSnapshotResponse } from '@univerjs/protocol';
-import { ILogContext, ISnapshotServerService } from '@univerjs-pro/collaboration';
 export declare class SnapshotServerOverHTTPService implements ISnapshotServerService {
     private readonly _configService;
     private readonly _httpService;
     constructor(_configService: IConfigService, _httpService: HTTPService);
     getUnitOnRev(_context: ILogContext, params: IGetUnitOnRevRequest): Promise<IGetUnitOnRevResponse>;
     getSheetBlock(_context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetSheetBlockResponse>;
+    getDeserializedSheetBlock(_context: ILogContext, params: IGetSheetBlockRequest): Promise<IGetDeserializedSheetBlockResponse>;
     fetchMissingChangesets(_context: ILogContext, params: IFetchMissingChangesetsRequest): Promise<IFetchMissingChangesetsResponse>;
     private _getSnapshotAPIPrefix;
     private _getAPIPrefix;
@@ -15,4 +16,5 @@ export declare class SnapshotServerOverHTTPService implements ISnapshotServerSer
     saveSnapshot(): Promise<ISaveSnapshotResponse>;
     saveSheetBlock(): Promise<ISaveSheetBlockResponse>;
     saveChangeset(): Promise<ISaveChangesetResponse>;
+    copyFileMeta(): Promise<ICopyFileMetaResponse>;
 }

package/lib/types/services/socket/collaboration-socket.service.d.ts

@@ -1,7 +1,7 @@
-import { Disposable, IConfigService, ILogService, Nullable } from '@univerjs/core';
-import { HTTPService, WebSocketService, ISocket } from '@univerjs/network';
-import { ISnapshotServerService, ICombRequestEvent, ICombResponseEvent, IFetchingMissEvent, ISubmitChangesetEvent } from '@univerjs-pro/collaboration';
+import { Nullable, Disposable, IConfigService, ILogService } from '@univerjs/core';
+import { ISocket, HTTPService, WebSocketService } from '@univerjs/network';
 import { IChangeset } from '@univerjs/protocol';
+import { ICombRequestEvent, ICombResponseEvent, IFetchingMissEvent, ISubmitChangesetEvent, ISnapshotServerService } from '@univerjs-pro/collaboration';
 import { Observable } from 'rxjs';
 export interface ICollaborationSocket extends Pick<ISocket, 'open$' | 'error$' | 'close$'> {
     memberID: string;