@ckeditor/ckeditor-cloud-services-collaboration 0.0.0-internal-20251222.0

package/dist/messagescompressor.d.ts

@@ -0,0 +1,19 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+/// <reference types="node" />
+/// <reference types="node" />
+import Message, { IMessageConstructor } from './message';
+/**
+ * Compresses and decompresses given message to/from the binary format using `Protocol Buffers`.
+ */
+export default class MessagesCompressor {
+    /**
+     * Creates an instance of a specific class from encoded buffer.
+     */
+    static decode<T extends IMessageConstructor>(buffer: Buffer, messageClass: T): unknown | InstanceType<T>;
+    /**
+     * Compress given message to buffer.
+     */
+    static encode(message: Message): Buffer;
+}

package/dist/messagesmapper.d.ts

@@ -0,0 +1,12 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+/**
+ * Mapper class used to convert messages types to readable names for metrics purposes.
+ */
+export default class MessagesMapper {
+    /**
+     * Maps message type (number) to string name.
+     */
+    static typeToStringName(messageType: number): string | number;
+}

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

@@ -0,0 +1,45 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { IDescriptorBody } from './../../descriptor';
+import { IRevisionObject } from '../revision';
+interface IBaseRevision {
+    /**
+     * As diffData property contains large size document data so this property is stringified and parsed only on the frontend side.
+     *
+     * Explanation:
+     * This is some kind of optimization for the backend. Usually, we did that the properties that was passed into some Message constructor,
+     * after serialization and deserialization were in the same format. Currently, as the diffData that goes into the message is large
+     * object and we do not need to do any logic operations on that property on the backend side after receiving the Message (we will just
+     * push them to the database), there is no need to do JSON.parse() when deserializing the message and again JSON.stringify() before
+     * pushing them into the database.
+     *
+     * That is why JSON.parse() and JSON.stringify() was not used in toJson() and fromJSON() methods.
+     */
+    diffData?: string;
+    revisionId: string;
+    name?: string;
+    creatorId?: string;
+    fromVersion?: number;
+    toVersion?: number;
+    isEmptyCurrent?: boolean;
+}
+export interface IRevisionJSON extends IBaseRevision {
+    createdAt?: string;
+    attributes?: string;
+    authorsIds?: string;
+}
+export interface IRevision extends IBaseRevision {
+    createdAt?: Date;
+    attributes?: Record<string, unknown>;
+    authorsIds?: string[];
+}
+export default class RevisionDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    static create(object: IRevisionObject): IRevision;
+    static toJSON(revision: IRevision): IRevisionJSON;
+    static fromJSON(json: IRevisionJSON): IRevision;
+    static toObject(revision: IRevision): IRevisionObject;
+}
+export {};

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

@@ -0,0 +1,18 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IRevisionHistoryConnectMessage extends IMessage {
+    documentId: string;
+}
+export default class RevisionHistoryConnectMessage 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(): IRevisionHistoryConnectMessage;
+    static fromJSON(object: IRevisionHistoryConnectMessage): RevisionHistoryConnectMessage;
+}

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

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

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

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

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

@@ -0,0 +1,44 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+import { IRevisionObject } from '../revision';
+import { IRevisionJSON, IRevision } from '../descriptors/revisiondescriptor';
+export interface IRevisionHistoryUpdateRevisions {
+    documentId: string;
+    requestId: number;
+    revisions: IRevisionObject[];
+}
+export interface IRevisionHistoryUpdateRevisionsMessageJSON extends IMessage {
+    documentId: string;
+    requestId: number;
+    revisions: IRevisionJSON[];
+}
+export default class RevisionHistoryUpdateRevisionsMessage extends Message {
+    readonly documentId: string;
+    readonly requestId: number;
+    readonly revisions: IRevision[];
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(documentId: string, requestId: number, revisions: IRevision[]);
+    toJSON(): IRevisionHistoryUpdateRevisionsMessageJSON;
+    /**
+     * Creates frontend revision history model array from message sent from the backend.
+     *
+     * This method is intended to be used on the frontend side after receiving the broadcast message from the backend.
+     */
+    toObject(): IRevisionHistoryUpdateRevisions;
+    /**
+     * Creates RevisionHistoryUpdateRevisionsMessage from frontend revision model array.
+     *
+     * This method is intended to be used on the frontend to create RevisionHistoryUpdateRevisionsMessage.
+     *
+     * This is optimization to prevent recreating the same revision models on the backend side
+     * as we just save these data in the database without need to parse them.
+     */
+    static create(params: IRevisionHistoryUpdateRevisions): RevisionHistoryUpdateRevisionsMessage;
+    static fromJSON(json: IRevisionHistoryUpdateRevisionsMessageJSON): RevisionHistoryUpdateRevisionsMessage;
+}

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

@@ -0,0 +1,33 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+import { IRevision, IRevisionJSON } from '../descriptors/revisiondescriptor';
+import { IRevisionObject } from '../revision';
+export interface IRevisionHistoryConnectResponseJSON extends IMessage {
+    channel: string;
+    requestId: number;
+    revisions: IRevisionJSON[];
+}
+export interface IRevisionHistoryConnectResponseObject {
+    channel: string;
+    requestId: number;
+    revisions: IRevisionObject[];
+}
+export default class RevisionHistoryConnectResponse extends Message {
+    readonly channel: string;
+    readonly requestId: number;
+    readonly revisions: IRevision[];
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(channel: string, requestId: number, revisions: IRevision[]);
+    toJSON(): IRevisionHistoryConnectResponseJSON;
+    /**
+     * Creates frontend revision history 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(): IRevisionHistoryConnectResponseObject;
+    static fromJSON(json: IRevisionHistoryConnectResponseJSON): RevisionHistoryConnectResponse;
+}

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

@@ -0,0 +1,33 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+import { IRevisionObject } from '../revision';
+import { IRevisionJSON, IRevision } from '../descriptors/revisiondescriptor';
+export interface IRevisionHistoryGetRevisionResponseJSON extends IRevisionJSON, IMessage {
+}
+export default class RevisionHistoryGetRevisionResponse extends Message implements IRevision {
+    readonly revisionId: string;
+    readonly name?: string | undefined;
+    readonly creatorId?: string | undefined;
+    readonly authorsIds?: string[] | undefined;
+    readonly createdAt?: Date | undefined;
+    readonly diffData?: string | undefined;
+    readonly attributes?: Record<string, unknown> | undefined;
+    readonly fromVersion?: number | undefined;
+    readonly toVersion?: number | undefined;
+    readonly isEmptyCurrent?: boolean | undefined;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(revisionId: string, name?: string | undefined, creatorId?: string | undefined, authorsIds?: string[] | undefined, createdAt?: Date | undefined, diffData?: string | undefined, attributes?: Record<string, unknown> | undefined, fromVersion?: number | undefined, toVersion?: number | undefined, isEmptyCurrent?: boolean | undefined);
+    toJSON(): IRevisionHistoryGetRevisionResponseJSON;
+    /**
+     * 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;
+    static create(params: IRevision): RevisionHistoryGetRevisionResponse;
+    static fromJSON(json: IRevisionHistoryGetRevisionResponseJSON): RevisionHistoryGetRevisionResponse;
+}

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

@@ -0,0 +1,16 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IRevisionHistoryUpdateRevisionsResponse extends IMessage {
+    requestId: number;
+}
+export default class RevisionHistoryUpdateRevisionsResponse extends Message {
+    readonly requestId: number;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(requestId: number);
+    toJSON(): IRevisionHistoryUpdateRevisionsResponse;
+    static fromJSON(json: IRevisionHistoryUpdateRevisionsResponse): RevisionHistoryUpdateRevisionsResponse;
+}

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

@@ -0,0 +1,18 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+/**
+ * Revision History model used on the frontend side.
+ */
+export interface IRevisionObject {
+    id: string;
+    name?: string;
+    creatorId?: string;
+    authorsIds?: string[];
+    fromVersion?: number;
+    toVersion?: number;
+    createdAt?: Date;
+    isEmptyCurrent?: boolean;
+    diffData?: Record<string, unknown>;
+    attributes?: Record<string, unknown>;
+}

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

@@ -0,0 +1,78 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
+import { IRevisionObject } from './revision';
+export declare const _SERVICE: number;
+interface IRevisionHistoryConnectResponse {
+    revisions: IRevisionObject[];
+    requestId: number;
+}
+declare const RevisionHistoryService_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
+};
+declare class RevisionHistoryService extends /* #__PURE__ -- @preserve */ RevisionHistoryService_base {
+    private readonly _documentId;
+    private _isConnected;
+    private _wsGateway?;
+    private _channel?;
+    private static readonly _SERVICE;
+    constructor(_documentId: string);
+    get isConnected(): boolean;
+    /**
+     * Connects RevisionHistoryService to CKEditor Cloud Services.
+     *
+     * @throws {@link CKEditorCloudServicesError} error
+     * Thrown in the case of errors on the backend side.
+     */
+    connect(wsGateway: IWebSocketGateway): Promise<IRevisionHistoryConnectResponse | void>;
+    /**
+     * Disconnects RevisionHistoryService from CKEditor Cloud Services.
+     *
+     * @throws {@link CKEditorCloudServicesError}
+     * Thrown in the case of errors on the backend side.
+     */
+    disconnect(): void;
+    /**
+     * Reconnects RevisionHistoryService to CKEditor Cloud Services.
+     *
+     * @throws {@link CKEditorCloudServicesError}
+     * Thrown when connection already exists or in the case of errors on the backend side.
+     */
+    reconnect(wsGateway: IWebSocketGateway, lastRequestId: number): Promise<IRevisionHistoryConnectResponse>;
+    /**
+     * Updates revisions.
+     *
+     * @throws {@link CKEditorCloudServicesError}
+     * Thrown in the case of errors on the backend side.
+     */
+    updateRevisions(revisions: IRevisionObject[], lastRequestId: number): Promise<number>;
+    /**
+     * Returns revision with given id.
+     *
+     * @throws {@link CKEditorCloudServicesError}
+     * Thrown in the case of errors on the backend side.
+     */
+    getRevision(revisionId: string): Promise<IRevisionObject>;
+    /**
+     * Connects or reconnects to WebSocketGateway and starts listening on channel.
+     */
+    private _connect;
+    /**
+     * Starts to listen on a given channel.
+     */
+    private _connectToChannel;
+    /**
+     * Processes websocket gateway state changes.
+     */
+    private _onWsGatewayStateChange;
+    /**
+     * Sends request to RevisionHistory service.
+     *
+     * @throws {@link ServiceNotConnectedError}
+     * Thrown in the case of missing service connection.
+     */
+    private _sendRequest;
+}
+export default RevisionHistoryService;

package/dist/services-content.css

@@ -0,0 +1,3 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */

package/dist/services-editor.css

@@ -0,0 +1,3 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */

package/dist/services.css

@@ -0,0 +1,3 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */

package/dist/services.d.ts

@@ -0,0 +1,19 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+export { default as User } from './users/user';
+export { default as WebSocketGateway, WEB_SOCKET_GATEWAY_STATES, type WebSocketGatewayState, type IWebSocketGatewayStates } from './websocketgateway/websocketgateway';
+export { default as EditorService } from './editor/editorservice';
+export { default as RevisionHistoryService } from './revision-history/revisionhistoryservice';
+export { default as TrackChangesService } from './track-changes/trackchangesservice';
+export { default as CollaborativeEditingService } from './collaborativeeditingservice/collaborativeeditingservice';
+export { default as CommentsService } from './comments-v2/commentsservice';
+export { default as CKEditorCloudServicesError } from './ckeditorcloudserviceserror';
+export type { IPublicError } from './ckeditorcloudservicesservererror';
+export type { IComment } from './comments-v2/descriptors/commentdescriptor';
+export type { ISuggestion } from './track-changes/descriptors/suggestiondescriptor';
+export type { IRevisionObject } from './revision-history/revision';
+export type { default as SessionCollection, ISocket } from './sessions/sessioncollection';
+export type { default as CollaborativeEditingConnectResponse } from './collaborativeeditingservice/responses/collaborativeeditingconnectresponse';
+export type { default as CollaborativeEditingResponse } from './collaborativeeditingservice/responses/collaborativeeditingresponse';
+export type { IOperationMetadata } from './collaborativeeditingservice/descriptors/operationmetadatadescriptor';