@ckeditor/ckeditor-cloud-services-collaboration 55.0.0 → 55.2.0

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

@@ -57,9 +57,11 @@ export { default as RevisionHistoryConnectMessage } from './revision-history/mes
 export { default as RevisionHistoryReconnectMessage } from './revision-history/messages/revisionhistoryreconnectmessage';
 export { default as RevisionHistoryGetRevisionMessage } from './revision-history/messages/revisionhistorygetrevisionmessage';
 export { default as RevisionHistoryUpdateRevisionsMessage } from './revision-history/messages/revisionhistoryupdaterevisionsmessage';
+export { default as RevisionHistoryGetLatestRevisionMessage } from './revision-history/messages/revisionhistorygetlatestrevisionmessage';
 export { default as RevisionHistoryConnectResponse } from './revision-history/responses/revisionhistoryconnectresponse';
 export { default as RevisionHistoryGetRevisionResponse } from './revision-history/responses/revisionhistorygetrevisionresponse';
 export { default as RevisionHistoryUpdateRevisionsResponse } from './revision-history/responses/revisionhistoryupdaterevisionsresponse';
+export { default as RevisionHistoryGetLatestRevisionResponse } from './revision-history/responses/revisionhistorygetlatestrevisionresponse';
 export type { IRevision } from './revision-history/descriptors/revisiondescriptor';
 export type { IRevisionObject } from './revision-history/revision';
 export { default as IsEditorBundleUploadedResponse, type IIsEditorBundleUploadedResponse } from './editor/responses/iseditorbundleuploadedresponse';

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/messages/revisionhistorygetlatestrevisionmessage.d.ts

@@ -0,0 +1,18 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { type IMessage } from './../../message';
+import type { IDescriptorBody } from '../../descriptor';
+export interface IRevisionHistoryGetLatestRevisionMessage extends IMessage {
+    documentId: string;
+}
+export default class RevisionHistoryGetLatestRevisionMessage extends Message {
+    readonly documentId: string;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(documentId: string);
+    toJSON(): IRevisionHistoryGetLatestRevisionMessage;
+    static fromJSON(object: IRevisionHistoryGetLatestRevisionMessage): RevisionHistoryGetLatestRevisionMessage;
+}

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/responses/revisionhistorygetlatestrevisionresponse.d.ts

@@ -0,0 +1,31 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { type IMessage } from './../../message';
+import type { IDescriptorBody } from '../../descriptor';
+import { type IRevision, type IRevisionJSON } from '../descriptors/revisiondescriptor';
+import type { IRevisionObject } from '../revision';
+export interface IRevisionHistoryGetLatestRevisionResponseJSON extends IMessage {
+    latestRevision?: IRevisionJSON;
+}
+export default class RevisionHistoryGetLatestRevisionResponse extends Message {
+    /**
+     * The latest revision of the document, with its `diffData`. It is missing when the document has no revisions.
+     */
+    readonly latestRevision?: IRevision | undefined;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(
+    /**
+     * The latest revision of the document, with its `diffData`. It is missing when the document has no revisions.
+     */
+    latestRevision?: IRevision | undefined);
+    toJSON(): IRevisionHistoryGetLatestRevisionResponseJSON;
+    /**
+     * Creates frontend revision model from message sent from the backend.
+     *
+     * This method is intended to be used on the frontend side after receiving the response from the backend.
+     */
+    toObject(): IRevisionObject | undefined;
+    static fromJSON(json: IRevisionHistoryGetLatestRevisionResponseJSON): RevisionHistoryGetLatestRevisionResponse;
+}

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

@@ -55,6 +55,15 @@ declare class RevisionHistoryService extends /* #__PURE__ -- @preserve */ Revisi
      * Thrown in the case of errors on the backend side.
      */
     getRevision(revisionId: string): Promise<IRevisionObject>;
+    /**
+     * Returns the latest revision of the document, with its `diffData`, or `undefined` when the document has no revisions.
+     *
+     * The service does not have to be connected, so the editor can build the initial data before it connects anything.
+     *
+     * @throws {@link CKEditorCloudServicesError}
+     * Thrown when the WebSocket Gateway is not connected, or in the case of errors on the backend side.
+     */
+    getLatestRevision(wsGateway: IWebSocketGateway): Promise<IRevisionObject | undefined>;
     /**
      * Connects or reconnects to WebSocketGateway and starts listening on channel.
      */