@ckeditor/ckeditor-cloud-services-collaboration 54.3.1 → 55.1.0

package/dist/channelservices.d.ts

@@ -23,23 +23,3 @@ export declare const REVISION_HISTORY_SERVICE_ID: number;
  * When adding a new channel-based service, add its id here.
  */
 export declare const CHANNEL_SERVICES: ReadonlyArray<number>;
-/**
- * Byte 0 of a request envelope that marks it as a batch of requests instead of a request to a single service.
- *
- * The gateway's `servicesMap` must never map this id, on SaaS or on-premises: that would turn every batch
- * into a request to the mapped service. Gateways that do not support batches fail fast on it with
- * `Service not found`, which reaches the client as a generic `500` server error. That `500` is what lets the client
- * fall back to single requests.
- */
-export declare const BATCH_SERVICE_ID: number;
-/**
- * Byte 1 of a batch request envelope: the type of the batch, as byte 1 of a single request is its method.
- *
- * Type 1 is the only one: the parts run in parallel and their responses come back in the order of the requests.
- */
-export declare const BATCH_REQUEST_TYPE: number;
-/**
- * The highest number of requests a single batch request may carry. The gateway rejects a larger batch, so the client
- * sends the requests of a larger batch one by one.
- */
-export declare const BATCH_MAX_PARTS: number;

package/dist/comments-v2/commentsservice.d.ts

@@ -2,7 +2,7 @@
  Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
  */
 import AddCommentResponse from './responses/addcommentresponse';
-import { type IServiceRequest, type IWebSocketGateway } from './../websocketgateway/websocketgateway';
+import { type IWebSocketGateway } from './../websocketgateway/websocketgateway';
 import type { IThread } from './descriptors/commentsthreaddescriptor';
 import type SessionCollection from '../sessions/sessioncollection';
 import type { IComment } from './descriptors/commentdescriptor';
@@ -42,17 +42,6 @@ declare class CommentsService extends /* #__PURE__ -- @preserve */ CommentsServi
      * Connects to WebSocketGateway and starts listening on channel.
      */
     connect(wsGateway: IWebSocketGateway): Promise<IThread[] | void>;
-    /**
-     * Prepares the service for connecting and returns its connect request, or `undefined` when it is already connected.
-     *
-     * @throws {@link CKEditorCloudServicesError}
-     * Thrown when the WebSocket Gateway is not connected.
-     */
-    beforeConnect(wsGateway: IWebSocketGateway): IServiceRequest | undefined;
-    /**
-     * Applies the response of the connect request: starts listening on the channel and on the gateway state.
-     */
-    afterConnect(wsGateway: IWebSocketGateway, response: Buffer): IThread[];
     /**
      * Disconnects CommentsService from CKEditor Cloud Services.
      */

package/dist/comments-v2/descriptors/connectdetailsdescriptor.d.ts

@@ -0,0 +1,14 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { type IDescriptorBody } from './../../descriptor';
+export interface ICommentsConnectDetails {
+    /**
+     * Requests the authors of the comments.
+     */
+    includeUsers?: boolean;
+}
+export default class ConnectDetailsDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+}

package/dist/comments-v2/messages/connectmessage.d.ts

@@ -3,16 +3,19 @@
  */
 import Message, { type IMessage } from './../../message';
 import type { IDescriptorBody } from '../../descriptor';
+import type { ICommentsConnectDetails } from '../descriptors/connectdetailsdescriptor';
 export interface IConnectMessage extends IMessage {
     documentId: string;
+    details?: ICommentsConnectDetails;
 }
 export default class ConnectMessage extends Message {
     readonly documentId: string;
+    readonly details?: ICommentsConnectDetails | undefined;
     static readonly TYPE: string;
     static readonly READABLE_TYPE_NAME: string;
     static readonly DESCRIPTOR_NAME: string;
     static readonly DESCRIPTOR: IDescriptorBody;
-    constructor(documentId: string);
+    constructor(documentId: string, details?: ICommentsConnectDetails | undefined);
     toJSON(): IConnectMessage;
     static fromJSON(object: IConnectMessage): ConnectMessage;
 }

package/dist/comments-v2/responses/connectresponse.d.ts

@@ -4,19 +4,22 @@
 import Message, { type IMessage } from './../../message';
 import type { IDescriptorBody } from '../../descriptor';
 import { type IThread, type IThreadJSON } from '../descriptors/commentsthreaddescriptor';
+import { type IUserJSON } from '../../users/descriptors/userdescriptor';
 export interface IConnectResponse extends IMessage {
     channel: string;
     threads?: string[];
     threadsV2?: IThreadJSON[];
+    users?: IUserJSON[];
 }
 export default class ConnectResponse extends Message {
     readonly channel: string;
     private readonly _threads?;
     private readonly _threadsV2?;
+    readonly users?: Record<string, unknown>[] | undefined;
     readonly threads: IThread[];
     static readonly DESCRIPTOR_NAME: string;
     static readonly DESCRIPTOR: IDescriptorBody;
-    constructor(channel: string, _threads?: IThread[] | undefined, _threadsV2?: IThread[] | undefined);
+    constructor(channel: string, _threads?: IThread[] | undefined, _threadsV2?: IThread[] | undefined, users?: Record<string, unknown>[] | undefined);
     toJSON(): IConnectResponse;
     static fromJSON(object: IConnectResponse): ConnectResponse;
 }

package/dist/index.d.ts

@@ -41,7 +41,7 @@ export { default as SessionsConnectResponse } from './sessions/responses/session
 export { default as SocketConnectMessage } from './sessions/messages/socketconnectmessage';
 export { default as SocketDisconnectMessage } from './sessions/messages/socketdisconnectmessage';
 export { default as ChannelDisconnectedMessage } from './websocketgateway/messages/channeldisconnectedmessage';
-export { CHANNEL_SERVICES, BATCH_SERVICE_ID, BATCH_REQUEST_TYPE, BATCH_MAX_PARTS } from './channelservices';
+export { CHANNEL_SERVICES } from './channelservices';
 export { default as AddSuggestionMessage } from './track-changes/messages/addsuggestionmessage';
 export { default as AddSuggestionResponse } from './track-changes/responses/addsuggestionresponse';
 export { default as GetAllSuggestionsResponse } from './track-changes/responses/getallsuggestionsresponse';
@@ -68,5 +68,3 @@ export * as Parser from './websocketgateway/parser/parser';
 export { Encoder, Decoder } from './websocketgateway/parser/parser';
 export { default as PacketParser, type IPacketParserOptions, type Packet } from './websocketgateway/parser/packetparser';
 export { default as ChannelMessage } from './websocketgateway/messages/channelmessage';
-export { default as BatchRequestMessage } from './websocketgateway/messages/batchrequestmessage';
-export { default as BatchResponseMessage } from './websocketgateway/messages/batchresponsemessage';

package/dist/revision-history/descriptors/connectdetailsdescriptor.d.ts

@@ -0,0 +1,18 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { type IDescriptorBody } from './../../descriptor';
+export interface IRevisionHistoryConnectDetails {
+    /**
+     * Requests the users of the `creatorId` and `authorsIds` of all revisions.
+     */
+    includeUsers?: boolean;
+    /**
+     * Requests the latest revision with its `diffData`.
+     */
+    includeLatestRevision?: boolean;
+}
+export default class ConnectDetailsDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+}

package/dist/revision-history/messages/revisionhistoryconnectmessage.d.ts

@@ -3,16 +3,19 @@
  */
 import Message, { type IMessage } from './../../message';
 import type { IDescriptorBody } from '../../descriptor';
+import type { IRevisionHistoryConnectDetails } from '../descriptors/connectdetailsdescriptor';
 export interface IRevisionHistoryConnectMessage extends IMessage {
     documentId: string;
+    details?: IRevisionHistoryConnectDetails;
 }
 export default class RevisionHistoryConnectMessage extends Message {
     readonly documentId: string;
+    readonly details?: IRevisionHistoryConnectDetails | undefined;
     static readonly TYPE: string;
     static readonly READABLE_TYPE_NAME: string;
     static readonly DESCRIPTOR_NAME: string;
     static readonly DESCRIPTOR: IDescriptorBody;
-    constructor(documentId: string);
+    constructor(documentId: string, details?: IRevisionHistoryConnectDetails | undefined);
     toJSON(): IRevisionHistoryConnectMessage;
     static fromJSON(object: IRevisionHistoryConnectMessage): RevisionHistoryConnectMessage;
 }

package/dist/revision-history/responses/revisionhistoryconnectresponse.d.ts

@@ -5,23 +5,37 @@ import Message, { type IMessage } from './../../message';
 import type { IDescriptorBody } from '../../descriptor';
 import { type IRevision, type IRevisionJSON } from '../descriptors/revisiondescriptor';
 import type { IRevisionObject } from '../revision';
+import { type IUserJSON } from '../../users/descriptors/userdescriptor';
 export interface IRevisionHistoryConnectResponseJSON extends IMessage {
     channel: string;
     requestId: number;
     revisions: IRevisionJSON[];
+    users?: IUserJSON[];
+    latestRevision?: IRevisionJSON;
 }
 export interface IRevisionHistoryConnectResponseObject {
     channel: string;
     requestId: number;
     revisions: IRevisionObject[];
+    users?: Record<string, unknown>[];
+    latestRevision?: IRevisionObject;
 }
 export default class RevisionHistoryConnectResponse extends Message {
     readonly channel: string;
     readonly requestId: number;
     readonly revisions: IRevision[];
+    readonly users?: Record<string, unknown>[] | undefined;
+    /**
+     * The last revision of {@link #revisions}, with its `diffData`.
+     */
+    readonly latestRevision?: IRevision | undefined;
     static readonly DESCRIPTOR_NAME: string;
     static readonly DESCRIPTOR: IDescriptorBody;
-    constructor(channel: string, requestId: number, revisions: IRevision[]);
+    constructor(channel: string, requestId: number, revisions: IRevision[], users?: Record<string, unknown>[] | undefined, 
+    /**
+     * The last revision of {@link #revisions}, with its `diffData`.
+     */
+    latestRevision?: IRevision | undefined);
     toJSON(): IRevisionHistoryConnectResponseJSON;
     /**
      * Creates frontend revision history model from message sent from the backend.

package/dist/revision-history/revisionhistoryservice.d.ts

@@ -1,7 +1,7 @@
 /*
  Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
  */
-import { type IServiceRequest, type IWebSocketGateway } from '../websocketgateway/websocketgateway';
+import { type IWebSocketGateway } from '../websocketgateway/websocketgateway';
 import type { IRevisionObject } from './revision';
 export declare const _SERVICE: number;
 interface IRevisionHistoryConnectResponse {
@@ -27,17 +27,6 @@ declare class RevisionHistoryService extends /* #__PURE__ -- @preserve */ Revisi
      * Thrown in the case of errors on the backend side.
      */
     connect(wsGateway: IWebSocketGateway): Promise<IRevisionHistoryConnectResponse | void>;
-    /**
-     * Prepares the service for connecting and returns its connect request, or `undefined` when it is already connected.
-     *
-     * @throws {@link CKEditorCloudServicesError}
-     * Thrown when the WebSocket Gateway is not connected.
-     */
-    beforeConnect(wsGateway: IWebSocketGateway): IServiceRequest | undefined;
-    /**
-     * Applies the response of the connect or reconnect request: starts listening on the channel and on the gateway state.
-     */
-    afterConnect(wsGateway: IWebSocketGateway, response: Buffer): IRevisionHistoryConnectResponse;
     /**
      * Disconnects RevisionHistoryService from CKEditor Cloud Services.
      *
@@ -70,13 +59,6 @@ declare class RevisionHistoryService extends /* #__PURE__ -- @preserve */ Revisi
      * Connects or reconnects to WebSocketGateway and starts listening on channel.
      */
     private _connect;
-    /**
-     * Prepares the service for connecting or reconnecting and returns the request.
-     *
-     * @throws {@link CKEditorCloudServicesError}
-     * Thrown when the WebSocket Gateway is not connected.
-     */
-    private _beforeConnect;
     /**
      * Starts to listen on a given channel.
      */

package/dist/services.d.ts

@@ -9,7 +9,6 @@ export { default as TrackChangesService } from './track-changes/trackchangesserv
 export { default as CollaborativeEditingService } from './collaborativeeditingservice/collaborativeeditingservice';
 export { default as CommentsService } from './comments-v2/commentsservice';
 export { default as CKEditorCloudServicesError } from './ckeditorcloudserviceserror';
-export { default as ServicesConnector, type IConnectableService, type ServicesConnectResults } from './servicesconnector/servicesconnector';
 export type { IPublicError } from './ckeditorcloudservicesservererror';
 export type { IComment } from './comments-v2/descriptors/commentdescriptor';
 export type { ISuggestion } from './track-changes/descriptors/suggestiondescriptor';