@ckeditor/ckeditor5-collaboration-core 44.1.0 → 44.2.0-alpha.1

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

@@ -1,13 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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/utils/confirmmixin.d.ts

@@ -1,28 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module collaboration-core/utils/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;
-}
-export type RemoveConfirmEvent = {
-    name: 'removeConfirm';
-    args: [];
-};

package/dist/utils/confirmview.d.ts

@@ -1,33 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module collaboration-core/utils/confirmview
- */
-import { View, type FocusableView } from 'ckeditor5/src/ui.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-export default class ConfirmView extends View implements FocusableView {
-    message: string;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-}
-export type ConfirmViewCancelEvent = {
-    name: 'cancel';
-    args: [];
-};
-export type ConfirmViewSubmitEvent = {
-    name: 'submit';
-    args: [];
-};

package/dist/utils/getdatetimeformatter.d.ts

@@ -1,33 +0,0 @@
-/**
- * @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-licensing-options
- */
-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/utils/getmarkerdomelement.d.ts

@@ -1,26 +0,0 @@
-/**
- * @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-licensing-options
- */
-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/utils/hashobject.d.ts

@@ -1,12 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module collaboration-core/utils/hashobject
- */
-export default function hashObject(obj: Record<string, unknown>): string;

package/dist/utils/sanitizeEditorConfig.d.ts

@@ -1,19 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module collaboration-core/utils/sanitizeditorconfig
- */
-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/utils/setupthreadkeyboardnavigation.d.ts

@@ -1,49 +0,0 @@
-/**
- * @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-licensing-options
- */
-import { type FocusableView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import type { BaseCommentThreadView } from '@ckeditor/ckeditor5-comments';
-import type { BaseSuggestionThreadView } from '@ckeditor/ckeditor5-track-changes';
-/**
- * A keystroke used to move focus from the editor content to a current annotation that has a marker
- * under user's selection.
- */
-export declare const FOCUS_ANNOTATION_KEYSTROKE: "Ctrl+Shift+E";
-/**
- * This helper initializes focus navigation within a thread using a keyboard.
- *
- * * It takes care of added and removed (dynamic) views in the thread.
- * * It takes care of the Enter key support (entering a thread).
- * * It takes care of the Esc key support (leaving a thread or whole sidebar).
- * * It takes care of the arrow key events being fired for the sidebar to navigate between individual threads.
- *
- * @param threadView A thread view in which the keyboard navigation will be enabled.
- * @param focusCycleableViews A collection of focusable views withing a thread.
- */
-export default function setupThreadKeyboardNavigation(threadView: BaseCommentThreadView | BaseSuggestionThreadView, focusCycleableViews: ViewCollection<FocusableView>): void;
-/**
- * An event fired when the user presses the Esc key while the entire thread is focused.
- */
-export type ThreadEscapeEvent = {
-    name: 'escape';
-    args: [];
-};
-/**
- * An event fired when the user presses the arrow up key while the entire thread is focused.
- */
-export type ThreadArrowUpEvent = {
-    name: 'arrowup';
-    args: [];
-};
-/**
- * An event fired when the user presses the arrow down key while the entire thread is focused.
- */
-export type ThreadArrowDownEvent = {
-    name: 'arrowdown';
-    args: [];
-};

package/dist/utils/surroundingmarkersdetector.d.ts

@@ -1,20 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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;

package/dist/utils/trim-html.d.ts

@@ -1,23 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module collaboration-core/utils/trim-html
- */
-/**
- * Trims text inside a html tags and takes care of all closing tags.
- *
- * @param html
- * @param options
- * @param limit Limit of the characters.
- * @param suffix
- */
-export default function trimHtml(html: string, { limit, suffix }: {
-    limit: number;
-    suffix?: string;
-}): string;