@ckeditor/ckeditor5-collaboration-core 41.2.1 → 41.3.0-alpha.2

package/dist/types/augmentation.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { LocaleConfig, Users } from './index.js';
+import type { RealTimeCollaborationConfig } from './config.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The locale configuration of the editor.
+         */
+        locale?: LocaleConfig;
+        /**
+         * The users plugin configuration.
+         */
+        users?: {
+            /**
+             * User ID value that will be used for the anonymous user.
+             */
+            anonymousUserId?: string;
+            /**
+             * Number of defined colors that are randomly assigned to users.
+             */
+            colorsCount?: number;
+        };
+        /**
+         * The configuration of the real time collaboration feature.
+         *
+         * Read more in {@link module:collaboration-core/config~RealTimeCollaborationConfig}.
+         *
+         * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+         */
+        collaboration?: RealTimeCollaborationConfig;
+    }
+    interface PluginsMap {
+        [Users.pluginName]: Users;
+    }
+}

package/dist/types/collaborationhistory.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/collaborationhistory
+ * @publicApi
+ */
+import type { default as CollaborationOperation } from './collaborationoperation.js';
+/**
+ * Interface compatible with {@link module:engine/model/history~History} with the difference that it uses
+ * {@link module:collaboration-core/collaborationoperation~CollaborationOperation} instead of regular model operations.
+ */
+export default interface CollaborationHistory {
+    _operations: Array<CollaborationOperation>;
+    version: number;
+    getOperations(fromBaseVersion?: number, toBaseVersion?: number): Array<CollaborationOperation>;
+    getOperation(baseVersion: number): CollaborationOperation | undefined;
+    addOperation(operation: CollaborationOperation): void;
+    reset(): void;
+}

package/dist/types/collaborationoperation.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/collaborationoperation
+ * @publicApi
+ */
+import type { Operation, InsertOperation, MergeOperation, MoveOperation, SplitOperation, MarkerOperation, RootOperation, RootAttributeOperation } from 'ckeditor5/src/engine.js';
+/**
+ * Extends the {@link module:engine/model/operation/operation operation}.
+ */
+export default interface CollaborationOperation extends Operation {
+    _isInit?: boolean;
+    _authorId?: null | string;
+    _isDisconnection?: boolean;
+    createdAt?: Date;
+    wasUndone?: boolean;
+    affectsData?: Record<string, any>;
+    clone(): CollaborationOperation;
+}
+export type InsertCollaborationOperation = CollaborationOperation & InsertOperation;
+export type MoveCollaborationOperation = CollaborationOperation & MoveOperation;
+export type MergeCollaborationOperation = CollaborationOperation & MergeOperation;
+export type SplitCollaborationOperation = CollaborationOperation & SplitOperation;
+export type MarkerCollaborationOperation = CollaborationOperation & MarkerOperation;
+export type RootCollaborationOperation = CollaborationOperation & RootOperation;
+export type RootAttributeCollaborationOperation = CollaborationOperation & RootAttributeOperation;

package/dist/types/config.d.ts

@@ -0,0 +1,106 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/config
+ * @publicApi
+ */
+/**
+ * The locale configuration.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		locale: {
+ * 			// The localization configuration.
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+ */
+export interface LocaleConfig {
+    /**
+     * A function that formats date to the custom format. It is used in dates in annotations (balloons) displaying
+     * comments and suggestions details.
+     *
+     * The default formatting can be changed by setting a custom formatting function to `config.locale.dateTimeFormat`.
+     *
+     * ```ts
+     * import format from 'date-fns/format';
+     *
+     * ClassicEditor
+     * 	.create( document.querySelector( '#editor' ), {
+     * 		toolbar: {
+     * 			items: [ 'bold', 'italic', '|', 'comment' ]
+     * 		},
+     * 		sidebar: {
+     * 			container: document.querySelector( '#sidebar' )
+     * 		},
+     * 		locale: {
+     * 			dateTimeFormat: date => format( date, 'dd/MM/yyyy' )
+     * 		}
+     * 	} )
+     * 	.catch( error => console.error( error ) );
+     * ```
+     *
+     * @returns The generated date.
+     */
+    dateTimeFormat?: (date: Date) => string;
+}
+/**
+ * The configuration of the real-time collaboration features.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		collaboration: ... // Collaboration features configuration.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface RealTimeCollaborationConfig {
+    /**
+     * The channel ID is a unique ID that identifies the data loaded in the editor instance or used by
+     * the context instance.
+     *
+     * If specified for the editor, it is the document ID.
+     *
+     * If you are using multiple editors instances at the same time, each of them should use a different
+     * channel ID to connect to a specific document.
+     *
+     * If specified for context, it is the ID for all the data related to context instance.
+     * This ID will be used for data that is not related to an editor instance, for example comments
+     * outside the editor.
+     *
+     * In the case of context, the ID can be an ID of a subpage or a form, or a different entity accordingly
+     * to your application.
+     *
+     * The channel ID can be used to recognize entity to which piece of data belongs in integrations that use `Context`
+     * and context plugins. For example, if you are preparing a custom integration using the comments API,
+     * you can use the channel ID to recognize whether the comment was added to an editor instance
+     * (and which one) or to the context.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( {
+     * 		collaboration: {
+     * 			channelId: 'your-channel-id'
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     */
+    channelId?: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export { default as Permissions } from './permissions.js';
+export { default as Users, type User } from './users.js';
+export { default as UserView } from './users/view/userview.js';
+export { default as getDateTimeFormatter } from './utils/getdatetimeformatter.js';
+export { default as getMarkerDomElement, getAllMarkersDomElementsSorted } from './utils/getmarkerdomelement.js';
+export { default as trimHtml } from './utils/trim-html.js';
+export { default as ConfirmMixin } from './utils/confirmmixin.js';
+export { default as hashObject } from './utils/hashobject.js';
+export { default as sanitizeEditorConfig } from './utils/sanitizeEditorConfig.js';
+export { default as surroundingMarkersDetector } from './utils/surroundingmarkersdetector.js';
+export type { default as CollaborationOperation, InsertCollaborationOperation, SplitCollaborationOperation, MarkerCollaborationOperation, MoveCollaborationOperation, MergeCollaborationOperation, RootCollaborationOperation, RootAttributeCollaborationOperation } from './collaborationoperation.js';
+export type { default as CollaborationHistory } from './collaborationhistory.js';
+export type { LocaleConfig, RealTimeCollaborationConfig } from './config.js';
+export * from './suggestionstyles.js';
+import './augmentation.js';

package/dist/types/permissions.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/permissions
+ * @publicApi
+ */
+import { ContextPlugin } from 'ckeditor5/src/core.js';
+/**
+ * The `Permissions` plugin manages permissions set for the local user.
+ *
+ * Following is the list of all defined permissions:
+ *
+ * * `document:write` - modify the content of the document, and resolve comment threads created by any user,
+ * * `comment:write` - create, edit and remove own comments and create, remove own comment threads,
+ * and resolve comment threads created by any user,
+ * * `comment:admin` - resolve and remove comment threads created by other users (enables `comment:write`).
+ * * `comment:modify_all` - edit and remove any comments created by other users.
+ *
+ * For example, a user with `comment:write` permission but with no `document:write` permission will be able to add
+ * comments but will not be able to change the document data (comments-only mode).
+ *
+ * By default, the following permissions are set: `document:write`, `comment:write`, `comment:admin`.
+ *
+ * Permissions are handled separately for each channel id (for each editor instance and context instance).
+ *
+ * See also the {@glink features/collaboration/users#user-permissions User permissions} guide to learn how to use this plugin.
+ */
+export default class Permissions extends ContextPlugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Permissions";
+    /**
+     * Sets permissions for editor/context instance with given `channelId`.
+     *
+     * If `channelId` is not set, the channel id of the editor/context to which the plugin was added will be used.
+     * This means that it is not required if the plugin is added to the editor configuration and {@link module:core/context~Context}
+     * is not used.
+     *
+     * @param permissions Permissions to set.
+     * @param channelId The channel ID.
+     */
+    setPermissions(permissions: Array<string>, channelId?: string): void;
+}

package/dist/types/suggestionstyles.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import '../theme/suggestion.css';
+import '../theme/suggestionmarker.css';
+import '../theme/integrations/image.css';
+import '../theme/integrations/horizontalline.css';
+import '../theme/integrations/mediaembed.css';
+import '../theme/integrations/pagebreak.css';
+import '../theme/integrations/table.css';
+import '../theme/integrations/codeblock.css';

package/dist/types/users/view/userview.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/users/view/userview
+ */
+import { View, type TemplateDefinition } from 'ckeditor5/src/ui.js';
+import type { Locale } from 'ckeditor5/src/utils.js';
+import type { User } from '../../users.js';
+import '../../../theme/users.css';
+export default class UserView extends View {
+    name: string;
+    notificationView: TemplateDefinition | null;
+    constructor(locale: Locale, user: User, notificationText?: null | string);
+}

package/dist/types/users.d.ts

@@ -0,0 +1,169 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/users
+ * @publicApi
+ */
+import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core.js';
+import { Collection } from 'ckeditor5/src/utils.js';
+import Permissions from './permissions.js';
+import '../theme/usercolors.css';
+/**
+ * The `Users` plugin provides the basic interface for setting and getting users involved in the document editing process.
+ */
+export default class Users extends ContextPlugin {
+    licenseKey: string;
+    /**
+     * Holds all {@link module:collaboration-core/users~User users} added to the editor.
+     *
+     * Note, that the {@link module:collaboration-core/users~User#isAnonymous anonymous user} is always present in the editor.
+     * You may want to filter it out when processing the users lists.
+     *
+     * ```ts
+     * for ( const user of editor.plugins.get( 'Users' ).users ) {
+     *     if ( !user.isAnonymous ) {
+     *         console.log( user.name );
+     *     }
+     * }
+     * ```
+     *
+     * Use {@link #addUser} to add a new user.
+     */
+    readonly users: Collection<User>;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Users";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Permissions];
+    /**
+     * @inheritDoc
+     */
+    constructor(context: Context | Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * A reference to the local user or `null` if it has not been set.
+     */
+    get me(): User | null;
+    /**
+     * Adds a new user to the list of users.
+     */
+    addUser({ id, name, ...additionalData }: Partial<UserData>): User;
+    /**
+     * Returns the user with a given ID.
+     */
+    getUser(id: string): User | null;
+    /**
+     * Sets an {@link module:collaboration-core/users~User#isAnonymous anonymous user} as {@link #me the local user}.
+     *
+     * The local user ID will be set to the value of `config.users.anonymousUserId` property. All actions performed by the local user
+     * will be contributed to the anonymous user.
+     */
+    useAnonymousUser(): void;
+    /**
+     * Sets the user with the given ID as the local user ({@link #me}).
+     *
+     * The local user can be only set once (this includes setting anonymous as the local user).
+     */
+    defineMe(userId: string): void;
+    /**
+     * Returns the author of the operation. It returns {@link #me} by default if it is not overwritten.
+     */
+    getOperationAuthor(): User | null;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}
+/**
+ * The representation of a single user that is involved in document editing.
+ */
+export declare class User {
+    /**
+     * The ID of the user.
+     */
+    id: string;
+    /**
+     * CSS colors classes object for the user.
+     */
+    color: Color;
+    /**
+     * The name of the user.
+     */
+    name: string;
+    /**
+     * The URL pointing to the image with the avatar of the user.
+     *
+     * If avatar is not set, default avatar is used.
+     */
+    avatar: string | undefined;
+    /**
+     * @param data User data.
+     * @param data.id The ID of the user.
+     * @param data.color A helper object to generate CSS classes with the user color in the UI.
+     * @param data.name The name of the user.
+     * @param data.avatar The URL to the user avatar.
+     */
+    constructor(data: UserData);
+    /**
+     * Is `true` for the anonymous user, `false` otherwise.
+     *
+     * The anonymous user is used when there is no defined user for given resource.
+     *
+     * The situations when the anonymous user is used will depend on your application. For example, it can be used when the editor can be
+     * used by "guest" users of your application, or when the original user's account was removed.
+     */
+    get isAnonymous(): boolean;
+    /**
+     * Is `true` for the {@link module:collaboration-core/users~Users#me local user}.
+     */
+    get isMe(): boolean;
+    /**
+     * The initials of the user.
+     *
+     * The initials are composed from the user name's first and last words:
+     *
+     * * for `Joe Doe`, the initials are `JD`,
+     * * for `Anonymous` the initials are `A`,
+     * * for `Katie John-Newman` the initials are `KJ`,
+     * * for `Adam Daniel Smith` the initials are `AS`.
+     */
+    get initials(): string;
+}
+/**
+ * The color object used to generate specified CSS classes with an individual color number assigned to the user.
+ */
+declare class Color {
+    constructor(colorId: number);
+    /**
+     * Returns CSS class for user avatar background color.
+     */
+    getBackgroundColorClass(): string;
+    /**
+     * Returns CSS class for user selection highlight (the selected range).
+     */
+    getSelectionClass(): string;
+    /**
+     * Returns CSS class for user caret position element (the pipe).
+     */
+    getMarkerClass(): string;
+}
+type UserData = {
+    id: string;
+    color: Color;
+    name: string;
+    avatar?: string;
+    _isAnonymous?: boolean;
+};
+export {};

package/dist/types/utils/common-translations.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/utils/common-translations
+ */
+import type { Locale } from 'ckeditor5/src/utils.js';
+export declare function getTranslation(locale: Locale, id: string): string;

package/dist/types/utils/confirmmixin.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module comments/comments/ui/view/confirmmixin
+ */
+import type { View } from 'ckeditor5/src/ui.js';
+import type { Locale, Mixed } from 'ckeditor5/src/utils.js';
+/**
+ * Adds interface for showing confirmation view in the specific for `CommentThreadView` and `CommentView` structure
+ * Confirm is always set to the `content` collection at the last position.
+ */
+export default function ConfirmMixin<Base extends new (...args: Array<any>) => View>(base: Base): Mixed<Base, ConfirmApi>;
+export interface ConfirmApi {
+    isConfirm: boolean;
+    locale: Locale;
+    showConfirm(message: string, element: Element): Promise<unknown>;
+    cancelConfirm(): void;
+}

package/dist/types/utils/confirmview.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module comments/comments/ui/view/confirmview
+ */
+import { View } from 'ckeditor5/src/ui.js';
+import type { Locale } from 'ckeditor5/src/utils.js';
+export default class ConfirmView extends View {
+    message: string;
+    constructor(locale: Locale);
+}

package/dist/types/utils/getdatetimeformatter.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { LocaleConfig } from '../config.js';
+/**
+ * Returns a function that formats the date to the set format.
+ *
+ * The default formatting can be changed by setting a custom formatting function to `config.locale.dateTimeFormat`.
+ *
+ * ```ts
+ * 	import format from 'date-fns/format';
+ *
+ *		ClassicEditor
+ *			.create( document.querySelector( '#editor' ), {
+ *				toolbar: {
+ *					items: [ 'bold', 'italic', '|', 'comment' ]
+ *				},
+ *				sidebar: {
+ *					container: document.querySelector( '#sidebar' )
+ *				},
+ *				locale: {
+ *					dateTimeFormat: date => format( date, 'dd/MM/yyyy' )
+ *				}
+ *			} )
+ *			.catch( error => console.error( error ) );
+ * ```
+ */
+export default function getDateTimeFormatter(localeConfig?: LocaleConfig): (date: Date | string) => string;

package/dist/types/utils/getmarkerdomelement.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { EditingController, Marker } from 'ckeditor5/src/engine.js';
+/**
+ * Returns a first DOM element mapped with the marker.
+ *
+ * @param editing Editing controller instance.
+ * @param marker Marker instance.
+ */
+export default function getMarkerDomElement(editing: EditingController, marker: Marker): HTMLElement | null;
+/**
+ * Returns all DOM elements mapped with all given markers. DOM elements are sorted by their client rects in top-most, left-most order.
+ * Returns `null` if `markers` is empty or there are no DOM elements bound with the markers.
+ *
+ * Note, that markers should not intersect.
+ *
+ * @param editing Editing controller instance.
+ * @param markers Markers instances.
+ */
+export declare function getAllMarkersDomElementsSorted(editing: EditingController, markers: Array<Marker>): Array<HTMLElement> | null;

package/dist/types/utils/hashobject.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module track-changes/utils/hashobject
+ */
+export default function hashObject(obj: Record<string, unknown>): string;

package/dist/types/utils/sanitizeEditorConfig.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/utils/common-translations
+ */
+import type { Editor, EditorConfig } from 'ckeditor5/src/core.js';
+/**
+ * A function that prepares config for internal editors removing all unnecessary plugins like RTC.
+ *
+ * @param editor The instance of the source editor.
+ * @param extraBlackListedPlugins Additional list of plugins that should not be added to the config.
+ */
+export default function sanitizeEditorConfig(editor: Editor, extraBlackListedPlugins?: Array<string>): EditorConfig;

package/dist/types/utils/surroundingmarkersdetector.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/utils/surroundingmarkersdetector
+ */
+import type { Marker, Model } from 'ckeditor5/src/engine.js';
+/**
+ * A utility that responds to range changes in the document selection and detects which markers' ranges
+ * touch or contain (surround) the document selection's focus.
+ */
+export default function surroundingMarkersDetector(model: Model, onMarkersChange: (changedMarkers: {
+    left: Array<Marker>;
+    entered: Array<Marker>;
+}) => void): void;