@ckeditor/ckeditor-cloud-services-collaboration 54.2.10 → 54.3.0

package/dist/channelservices.d.ts

@@ -23,3 +23,23 @@ 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 IWebSocketGateway } from './../websocketgateway/websocketgateway';
+import { type IServiceRequest, type IWebSocketGateway } from './../websocketgateway/websocketgateway';
 import type { IThread } from './descriptors/commentsthreaddescriptor';
 import type SessionCollection from '../sessions/sessioncollection';
 import type { IComment } from './descriptors/commentdescriptor';
@@ -42,6 +42,17 @@ 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/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 } from './channelservices';
+export { CHANNEL_SERVICES, BATCH_SERVICE_ID, BATCH_REQUEST_TYPE, BATCH_MAX_PARTS } 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,3 +68,5 @@ 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/revisionhistoryservice.d.ts

@@ -1,7 +1,7 @@
 /*
  Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
  */
-import { type IWebSocketGateway } from '../websocketgateway/websocketgateway';
+import { type IServiceRequest, type IWebSocketGateway } from '../websocketgateway/websocketgateway';
 import type { IRevisionObject } from './revision';
 export declare const _SERVICE: number;
 interface IRevisionHistoryConnectResponse {
@@ -27,6 +27,17 @@ 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.
      *
@@ -59,6 +70,13 @@ 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,6 +9,7 @@ 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';