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

package/dist/sessions/descriptors/sessiondescriptor.d.ts

@@ -0,0 +1,8 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { IDescriptorBody } from './../../descriptor';
+export default class SessionsSocketDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+}

package/dist/sessions/messages/sessionsconnectmessage.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 ISessionsConnectMessage extends IMessage {
+    id: string;
+    sessionType: number | string;
+}
+export default class SessionsConnectMessage extends Message {
+    readonly id: string;
+    readonly sessionType: string | number;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, sessionType: string | number);
+    toJSON(): ISessionsConnectMessage;
+    static fromJSON(data: ISessionsConnectMessage): SessionsConnectMessage;
+}

package/dist/sessions/messages/socketconnectmessage.d.ts

@@ -0,0 +1,24 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface ISocketConnectMessage extends IMessage {
+    id: string;
+    userId?: string;
+    role?: string;
+    permissions?: string[];
+}
+export default class SocketConnectMessage extends Message {
+    readonly id: string;
+    readonly userId?: string | undefined;
+    readonly role?: string | undefined;
+    readonly permissions?: string[] | undefined;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, userId?: string | undefined, role?: string | undefined, permissions?: string[] | undefined);
+    toJSON(): ISocketConnectMessage;
+    static fromJSON(data: ISocketConnectMessage): SocketConnectMessage;
+}

package/dist/sessions/messages/socketdisconnectmessage.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 ISocketDisconnectMessage extends IMessage {
+    id: string;
+}
+export default class SocketDisconnectMessage extends Message {
+    readonly id: string;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string);
+    toJSON(): ISocketDisconnectMessage;
+    static fromJSON(data: ISocketDisconnectMessage): SocketDisconnectMessage;
+}

package/dist/sessions/responses/sessionsconnectresponse.d.ts

@@ -0,0 +1,24 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+import { ISocket } from '../sessioncollection';
+export interface ISessionsConnectResponse extends IMessage {
+    channel: string;
+    sockets: {
+        user?: string;
+        session: string;
+        role?: string;
+        permissions?: string[];
+    }[];
+}
+export default class SessionsConnectResponse extends Message {
+    readonly channel: string;
+    readonly sockets: ISocket[];
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(channel: string, sockets?: ISocket[]);
+    toJSON(): ISessionsConnectResponse;
+    static fromJSON(data: ISessionsConnectResponse): SessionsConnectResponse;
+}

package/dist/sessions/sessioncollection.d.ts

@@ -0,0 +1,43 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import { Collection } from '@ckeditor/ckeditor5-utils';
+import User from './../users/user';
+import { IWebSocketGateway } from './../websocketgateway/websocketgateway';
+export declare const _SERVICE: number;
+export interface ISocket {
+    id: string;
+    user?: User;
+    userId?: string;
+    role?: string;
+    permissions?: string[];
+}
+/**
+ * Collection of connected socket to given service.
+ */
+declare class SessionCollection extends Collection<ISocket> {
+    private readonly _id;
+    private readonly _sessionType;
+    private readonly _handlers;
+    private _channel?;
+    private _wsGateway?;
+    private _connected;
+    private _eventsQueue;
+    private _isRunning;
+    constructor(_id: string, _sessionType: number);
+    /**
+     * Connects SessionCollection to CKEditor Cloud Services..
+     */
+    connect(wsGateway: IWebSocketGateway): Promise<void>;
+    /**
+     * Disconnects SessionCollection from CKEditor Cloud Services.
+     */
+    disconnect(force?: boolean): void;
+    add(_1: ISocket, _2?: number): this;
+    remove(_: number): ISocket;
+    private _connectToChannel;
+    private _onWsGatewayStateChange;
+    private _runQueue;
+    private _addHandler;
+}
+export default SessionCollection;

package/dist/sessions/sessions.d.ts

@@ -0,0 +1,16 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import SessionCollection from './sessioncollection';
+import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
+/**
+ * Abstracts requesting connected Sessions for services. Should not be used directly
+ */
+export default class Sessions {
+    /**
+     * Returns a Promise that resolves with read-only observable collection with EndUsers Sessions for given service instance.
+     *
+     *    const sessions = await wsGateway.getConnectedSessions( wsGateway, 'some-uuid', 'session-type' );
+     */
+    static getConnectedSessions(wsGateway: IWebSocketGateway, id: string, sessionType: number): Promise<SessionCollection>;
+}

package/dist/track-changes/descriptors/suggestiondescriptor.d.ts

@@ -0,0 +1,28 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { IDescriptorBody } from './../../descriptor';
+interface ICommonSuggestion {
+    id: string;
+    authorId: string;
+    type: string;
+    hasComments?: boolean;
+    state?: string;
+}
+export interface ISuggestion extends ICommonSuggestion {
+    createdAt?: Date;
+    data?: Record<string, unknown> | null;
+    attributes?: Record<string, unknown> | null;
+}
+export interface ISuggestionJSON extends ICommonSuggestion {
+    createdAt?: string;
+    data?: string | null;
+    attributes?: string | null;
+}
+export default class SuggestionDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    static toJSON(suggestion: ISuggestion): ISuggestionJSON;
+    static fromJSON(suggestion: ISuggestionJSON): ISuggestion;
+}
+export {};

package/dist/track-changes/messages/addsuggestionmessage.d.ts

@@ -0,0 +1,28 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IAddSuggestionMessage extends IMessage {
+    id: string;
+    documentId: string;
+    type: string;
+    data: string;
+    originalSuggestionId: string | null;
+    attributes: string | null;
+}
+export default class AddSuggestionMessage extends Message {
+    readonly id: string;
+    readonly documentId: string;
+    readonly type: string;
+    readonly data: Record<string, unknown>;
+    readonly originalSuggestionId: string | null;
+    readonly attributes: Record<string, unknown> | null;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, documentId: string, type: string, data?: Record<string, unknown>, originalSuggestionId?: string | null, attributes?: Record<string, unknown> | null);
+    toJSON(): IAddSuggestionMessage;
+    static fromJSON(object: IAddSuggestionMessage): AddSuggestionMessage;
+}

package/dist/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts

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

package/dist/track-changes/messages/connectmessage.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 IConnectMessage extends IMessage {
+    documentId: string;
+}
+export default class ConnectMessage 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(): IConnectMessage;
+    static fromJSON(object: IConnectMessage): ConnectMessage;
+}

package/dist/track-changes/messages/getallsuggestionsmessage.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 IGetAllSuggestionsMessage extends IMessage {
+    documentId: string;
+}
+export default class GetAllSuggestionsMessage 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(): IGetAllSuggestionsMessage;
+    static fromJSON(object: IGetAllSuggestionsMessage): GetAllSuggestionsMessage;
+}

package/dist/track-changes/messages/getsuggestionmessage.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 IGetSuggestionMessage extends IMessage {
+    id: string;
+    documentId: string;
+}
+export default class GetSuggestionMessage extends Message {
+    readonly id: string;
+    readonly documentId: string;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, documentId: string);
+    toJSON(): IGetSuggestionMessage;
+    static fromJSON(object: IGetSuggestionMessage): GetSuggestionMessage;
+}

package/dist/track-changes/messages/updatesuggestionmessage.d.ts

@@ -0,0 +1,28 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IUpdateSuggestionMessage extends IMessage {
+    id: string;
+    documentId: string;
+    hasComments?: boolean;
+    isHasCommentsModified: boolean;
+    state?: string;
+    attributes: string;
+}
+export default class UpdateSuggestionMessage extends Message {
+    readonly id: string;
+    readonly documentId: string;
+    readonly hasComments: boolean | undefined;
+    readonly isHasCommentsModified: boolean;
+    readonly state?: string | undefined;
+    readonly attributes: Record<string, unknown> | null;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, documentId: string, hasComments: boolean | undefined, isHasCommentsModified: boolean, state?: string | undefined, attributes?: Record<string, unknown> | null);
+    toJSON(): IUpdateSuggestionMessage;
+    static fromJSON(object: IUpdateSuggestionMessage): UpdateSuggestionMessage;
+}

package/dist/track-changes/responses/addsuggestionresponse.d.ts

@@ -0,0 +1,30 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IAddSuggestionResponse extends IMessage {
+    id: string;
+    authorId: string;
+    type: string;
+    createdAt?: string;
+    data: string;
+    hasComments?: boolean;
+    state?: string;
+    attributes: string | null;
+}
+export default class AddSuggestionResponse extends Message {
+    readonly id: string;
+    readonly authorId: string;
+    readonly type: string;
+    readonly hasComments?: boolean | undefined;
+    readonly state?: string | undefined;
+    readonly data: Record<string, unknown> | null;
+    readonly attributes: Record<string, unknown> | null;
+    readonly createdAt?: Date;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, authorId: string, type: string, createdAt?: string, hasComments?: boolean | undefined, state?: string | undefined, data?: Record<string, unknown> | null, attributes?: Record<string, unknown> | null);
+    toJSON(): IAddSuggestionResponse;
+    static fromJSON(data: IAddSuggestionResponse): AddSuggestionResponse;
+}

package/dist/track-changes/responses/connectresponse.d.ts

@@ -0,0 +1,22 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+import { ISuggestion, ISuggestionJSON } from '../descriptors/suggestiondescriptor';
+export interface IConnectResponse extends IMessage {
+    channel: string;
+    suggestions?: string[];
+    suggestionsV2?: ISuggestionJSON[];
+}
+export default class ConnectResponse extends Message {
+    readonly channel: string;
+    private readonly _suggestions?;
+    private readonly _suggestionsV2?;
+    readonly suggestions: ISuggestion[];
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(channel: string, _suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined);
+    toJSON(): IConnectResponse;
+    static fromJSON(object: IConnectResponse): ConnectResponse;
+}

package/dist/track-changes/responses/getallsuggestionsresponse.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';
+import { ISuggestion, ISuggestionJSON } from '../descriptors/suggestiondescriptor';
+export interface IGetAllSuggestionResponse extends IMessage {
+    suggestions?: string[];
+    suggestionsV2?: ISuggestionJSON[];
+}
+export default class GetAllSuggestionResponse extends Message {
+    private readonly _suggestions?;
+    private readonly _suggestionsV2?;
+    readonly suggestions: ISuggestion[];
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(_suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined);
+    toJSON(): IGetAllSuggestionResponse;
+    static fromJSON(data: IGetAllSuggestionResponse): GetAllSuggestionResponse;
+}

package/dist/track-changes/responses/getsuggestionresponse.d.ts

@@ -0,0 +1,30 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Message, { IMessage } from './../../message';
+import { IDescriptorBody } from '../../descriptor';
+export interface IGetSuggestionResponse extends IMessage {
+    id: string;
+    authorId: string;
+    type: string;
+    createdAt: string;
+    data: string;
+    hasComments: boolean;
+    state: string;
+    attributes: string | null;
+}
+export default class GetSuggestionResponse extends Message {
+    readonly id: string;
+    readonly authorId: string;
+    readonly type: string;
+    readonly hasComments: boolean;
+    readonly state: string;
+    readonly data: Record<string, unknown>;
+    readonly attributes: Record<string, unknown> | null;
+    readonly createdAt: Date;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string, authorId: string, type: string, createdAt: string, hasComments: boolean, state: string, data?: Record<string, unknown>, attributes?: Record<string, unknown> | null);
+    toJSON(): IGetSuggestionResponse;
+    static fromJSON(data: IGetSuggestionResponse): GetSuggestionResponse;
+}

package/dist/track-changes/trackchangesservice.d.ts

@@ -0,0 +1,65 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import AddSuggestionResponse from './responses/addsuggestionresponse';
+import GetSuggestionResponse from './responses/getsuggestionresponse';
+import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
+import { ISuggestion } from './descriptors/suggestiondescriptor';
+export declare const _SERVICE: number;
+interface ISuggestionUpdateProps {
+    hasComments?: boolean;
+    state?: string;
+    attributes?: Record<string, unknown>;
+}
+export interface IBatchUpdateSuggestionsStateParams {
+    ids: string[];
+    state: string;
+}
+declare const TrackChangesService_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
+};
+declare class TrackChangesService extends /* #__PURE__ -- @preserve */ TrackChangesService_base {
+    private readonly _documentId;
+    private _isConnected;
+    private _wsGateway?;
+    private _channel?;
+    private static readonly _SERVICE;
+    constructor(_documentId: string);
+    get isConnected(): boolean;
+    /**
+     * Connects to WebSocketGateway and starts listening on channel.
+     */
+    connect(wsGateway: IWebSocketGateway): Promise<ISuggestion[] | void>;
+    /**
+     * Disconnects TrackChangesService from CKEditor Cloud Services.
+     */
+    disconnect(): void;
+    /**
+     * Adds suggestion and returns AddSuggestionResponse.
+     */
+    add(id: string, type: string, data: Record<string, unknown>, originalSuggestionId?: string | null, attributes?: Record<string, unknown>): Promise<AddSuggestionResponse>;
+    /**
+     * Returns suggestion with given id.
+     */
+    get(id: string, attempt?: number): Promise<GetSuggestionResponse>;
+    /**
+     * Returns suggestions from given documentId.
+     */
+    getAll(): Promise<ISuggestion[]>;
+    /**
+     * Updates suggestion.
+     */
+    update(id: string, props?: ISuggestionUpdateProps): Promise<void>;
+    batchUpdateState(params: IBatchUpdateSuggestionsStateParams): Promise<void>;
+    /**
+     * Starts to listen on a given channel.
+     */
+    private _connectToChannel;
+    /**
+     * Processes websocket gateway state changes.
+     */
+    private _onWsGatewayStateChange;
+    private _sendRequest;
+}
+export default TrackChangesService;

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+export type TokenChangeValueEventCallback = (event: Record<string, unknown>, name: string, value: ArrayBuffer) => void | Promise<void>;
+export interface IToken {
+    value: string | ArrayBuffer;
+    refreshToken(): Promise<void> | void;
+    on(event: string, handler: TokenChangeValueEventCallback): void;
+    off(event: string, handler: TokenChangeValueEventCallback): void;
+}

package/dist/users/descriptors/userdescriptor.d.ts

@@ -0,0 +1,8 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import Descriptor, { IDescriptorBody } from './../../descriptor';
+export default class UserDescriptor extends Descriptor {
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+}

package/dist/users/messages/getmanyusersmessage.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 IGetManyUsersMessage extends IMessage {
+    ids: string[];
+}
+export default class GetManyUsersMessage extends Message {
+    readonly ids: string[];
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(ids: string[]);
+    toJSON(): IGetManyUsersMessage;
+    static fromJSON(data: IGetManyUsersMessage): GetManyUsersMessage;
+}

package/dist/users/messages/getusermessage.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 IGetUserMessage extends IMessage {
+    id: string;
+}
+export default class GetUserMessage extends Message {
+    readonly id: string;
+    static readonly TYPE: string;
+    static readonly READABLE_TYPE_NAME: string;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(id: string);
+    toJSON(): IGetUserMessage;
+    static fromJSON(data: IGetUserMessage): GetUserMessage;
+}

package/dist/users/responses/getmanyusersresponse.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 IGetManyUsersResponse extends IMessage {
+    users: Record<string, unknown>[];
+}
+export default class GetManyUsersResponse extends Message {
+    readonly users: Record<string, unknown>[];
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(users: Record<string, unknown>[]);
+    toJSON(): IGetManyUsersResponse;
+    static fromJSON(data: IGetManyUsersResponse): GetManyUsersResponse;
+}

package/dist/users/responses/getuserresponse.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 IGetUserResponse extends IMessage {
+    attributes: Record<string, string>[];
+}
+export default class GetUserResponse extends Message {
+    readonly attributes: Record<string, unknown>;
+    static readonly DESCRIPTOR_NAME: string;
+    static readonly DESCRIPTOR: IDescriptorBody;
+    constructor(attributes: Record<string, unknown>);
+    toJSON(): IGetUserResponse;
+    static fromJSON(data: IGetUserResponse): GetUserResponse;
+}

package/dist/users/user.d.ts

@@ -0,0 +1,44 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
+interface IUserData extends Record<string, unknown> {
+    id?: string;
+}
+/**
+ * Represents User entity.
+ */
+declare class User {
+    static readonly _SERVICE: number;
+    readonly id?: string;
+    private readonly _attributes;
+    /**
+     * Creates User object. Passed attributes will be set on instance as a read-only attributes.
+     * Passing undefined or empty object will create "Anonymous" object.
+     */
+    constructor(attributes?: IUserData);
+    /**
+     * Creates User from data object, ie. from token data.
+     *
+     *     const user = User.fromData( { id: '1234', name: 'Bob' } );
+     *
+     *     // Anonymous user will have no attributes.
+     *     const anonymous = User.fromData();
+     */
+    static fromData(data: IUserData): User;
+    /**
+     * Returns existing User from server or create a User object.
+     *
+     *     const user = await User.get( wsGateway, '1234' );
+     */
+    static get(wsGateway: IWebSocketGateway, id: string): Promise<User>;
+    /**
+     * Returns existing Users from server or create a User objects.
+     *
+     *     const users = await User.getMany( wsGateway, ['1234', '5678'] );
+     */
+    static getMany(wsGateway: IWebSocketGateway, ids: string[]): Promise<User[]>;
+}
+declare interface User extends Record<string, unknown> {
+}
+export default User;

package/dist/version.d.ts

@@ -0,0 +1,5 @@
+/*
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
+ */
+declare const _default: "0.0.0-internal-20251222.0";
+export default _default;