@ckeditor/ckeditor5-link 41.2.0 → 41.3.0-alpha.1

package/dist/types/augmentation.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 { LinkConfig, AutoLink, Link, LinkEditing, LinkImage, LinkImageEditing, LinkImageUI, LinkUI, LinkCommand, UnlinkCommand } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:link/link~Link} feature.
+         *
+         * Read more in {@link module:link/linkconfig~LinkConfig}.
+         */
+        link?: LinkConfig;
+    }
+    interface PluginsMap {
+        [AutoLink.pluginName]: AutoLink;
+        [Link.pluginName]: Link;
+        [LinkEditing.pluginName]: LinkEditing;
+        [LinkImage.pluginName]: LinkImage;
+        [LinkImageEditing.pluginName]: LinkImageEditing;
+        [LinkImageUI.pluginName]: LinkImageUI;
+        [LinkUI.pluginName]: LinkUI;
+    }
+    interface CommandsMap {
+        link: LinkCommand;
+    }
+    interface CommandsMap {
+        unlink: UnlinkCommand;
+    }
+}

package/dist/types/autolink.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @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 link/autolink
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Delete } from 'ckeditor5/src/typing.js';
+import LinkEditing from './linkediting.js';
+/**
+ * The autolink plugin.
+ */
+export default class AutoLink extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Delete, typeof LinkEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AutoLink";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * For given position, returns a range that includes the whole link that contains the position.
+     *
+     * If position is not inside a link, returns `null`.
+     */
+    private _expandLinkRange;
+    /**
+     * Extends the document selection to includes all links that intersects with given `selectedRange`.
+     */
+    private _selectEntireLinks;
+    /**
+     * Enables autolinking on pasting a URL when some content is selected.
+     */
+    private _enablePasteLinking;
+    /**
+     * Enables autolinking on typing.
+     */
+    private _enableTypingHandling;
+    /**
+     * Enables autolinking on the <kbd>Enter</kbd> key.
+     */
+    private _enableEnterHandling;
+    /**
+     * Enables autolinking on the <kbd>Shift</kbd>+<kbd>Enter</kbd> keyboard shortcut.
+     */
+    private _enableShiftEnterHandling;
+    /**
+     * Checks if the passed range contains a linkable text.
+     */
+    private _checkAndApplyAutoLinkOnRange;
+    /**
+     * Applies a link on a given range if the link should be applied.
+     *
+     * @param url The URL to link.
+     * @param range The text range to apply the link attribute to.
+     */
+    private _applyAutoLink;
+    /**
+     * Enqueues autolink changes in the model.
+     *
+     * @param url The URL to link.
+     * @param range The text range to apply the link attribute to.
+     */
+    private _persistAutoLink;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 link
+ */
+export { default as Link } from './link.js';
+export { default as LinkEditing } from './linkediting.js';
+export { default as LinkUI } from './linkui.js';
+export { default as LinkImage } from './linkimage.js';
+export { default as LinkImageEditing } from './linkimageediting.js';
+export { default as LinkImageUI } from './linkimageui.js';
+export { default as AutoLink } from './autolink.js';
+export type { LinkConfig, LinkDecoratorDefinition } from './linkconfig.js';
+export { default as LinkCommand } from './linkcommand.js';
+export { default as UnlinkCommand } from './unlinkcommand.js';
+import './augmentation.js';

package/dist/types/link.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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 link/link
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import LinkEditing from './linkediting.js';
+import LinkUI from './linkui.js';
+import AutoLink from './autolink.js';
+/**
+ * The link plugin.
+ *
+ * This is a "glue" plugin that loads the {@link module:link/linkediting~LinkEditing link editing feature}
+ * and {@link module:link/linkui~LinkUI link UI feature}.
+ */
+export default class Link extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LinkEditing, typeof LinkUI, typeof AutoLink];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Link";
+}

package/dist/types/linkcommand.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @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 link/linkcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { Collection } from 'ckeditor5/src/utils.js';
+import AutomaticDecorators from './utils/automaticdecorators.js';
+import type ManualDecorator from './utils/manualdecorator.js';
+/**
+ * The link command. It is used by the {@link module:link/link~Link link feature}.
+ */
+export default class LinkCommand extends Command {
+    /**
+     * The value of the `'linkHref'` attribute if the start of the selection is located in a node with this attribute.
+     *
+     * @observable
+     * @readonly
+     */
+    value: string | undefined;
+    /**
+     * A collection of {@link module:link/utils/manualdecorator~ManualDecorator manual decorators}
+     * corresponding to the {@link module:link/linkconfig~LinkConfig#decorators decorator configuration}.
+     *
+     * You can consider it a model with states of manual decorators added to the currently selected link.
+     */
+    readonly manualDecorators: Collection<ManualDecorator>;
+    /**
+     * An instance of the helper that ties together all {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition}
+     * that are used by the {@glink features/link link} and the {@glink features/images/images-linking linking images} features.
+     */
+    readonly automaticDecorators: AutomaticDecorators;
+    /**
+     * Synchronizes the state of {@link #manualDecorators} with the currently present elements in the model.
+     */
+    restoreManualDecoratorStates(): void;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * When the selection is non-collapsed, the `linkHref` attribute will be applied to nodes inside the selection, but only to
+     * those nodes where the `linkHref` attribute is allowed (disallowed nodes will be omitted).
+     *
+     * When the selection is collapsed and is not inside the text with the `linkHref` attribute, a
+     * new {@link module:engine/model/text~Text text node} with the `linkHref` attribute will be inserted in place of the caret, but
+     * only if such element is allowed in this place. The `_data` of the inserted text will equal the `href` parameter.
+     * The selection will be updated to wrap the just inserted text node.
+     *
+     * When the selection is collapsed and inside the text with the `linkHref` attribute, the attribute value will be updated.
+     *
+     * # Decorators and model attribute management
+     *
+     * There is an optional argument to this command that applies or removes model
+     * {@glink framework/architecture/editing-engine#text-attributes text attributes} brought by
+     * {@link module:link/utils/manualdecorator~ManualDecorator manual link decorators}.
+     *
+     * Text attribute names in the model correspond to the entries in the {@link module:link/linkconfig~LinkConfig#decorators
+     * configuration}.
+     * For every decorator configured, a model text attribute exists with the "link" prefix. For example, a `'linkMyDecorator'` attribute
+     * corresponds to `'myDecorator'` in the configuration.
+     *
+     * To learn more about link decorators, check out the {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`}
+     * documentation.
+     *
+     * Here is how to manage decorator attributes with the link command:
+     *
+     * ```ts
+     * const linkCommand = editor.commands.get( 'link' );
+     *
+     * // Adding a new decorator attribute.
+     * linkCommand.execute( 'http://example.com', {
+     * 	linkIsExternal: true
+     * } );
+     *
+     * // Removing a decorator attribute from the selection.
+     * linkCommand.execute( 'http://example.com', {
+     * 	linkIsExternal: false
+     * } );
+     *
+     * // Adding multiple decorator attributes at the same time.
+     * linkCommand.execute( 'http://example.com', {
+     * 	linkIsExternal: true,
+     * 	linkIsDownloadable: true,
+     * } );
+     *
+     * // Removing and adding decorator attributes at the same time.
+     * linkCommand.execute( 'http://example.com', {
+     * 	linkIsExternal: false,
+     * 	linkFoo: true,
+     * 	linkIsDownloadable: false,
+     * } );
+     * ```
+     *
+     * **Note**: If the decorator attribute name is not specified, its state remains untouched.
+     *
+     * **Note**: {@link module:link/unlinkcommand~UnlinkCommand#execute `UnlinkCommand#execute()`} removes all
+     * decorator attributes.
+     *
+     * @fires execute
+     * @param href Link destination.
+     * @param manualDecoratorIds The information about manual decorator attributes to be applied or removed upon execution.
+     */
+    execute(href: string, manualDecoratorIds?: Record<string, boolean>): void;
+    /**
+     * Provides information whether a decorator with a given name is present in the currently processed selection.
+     *
+     * @param decoratorName The name of the manual decorator used in the model
+     * @returns The information whether a given decorator is currently present in the selection.
+     */
+    private _getDecoratorStateFromModel;
+    /**
+     * Checks whether specified `range` is inside an element that accepts the `linkHref` attribute.
+     *
+     * @param range A range to check.
+     * @param allowedRanges An array of ranges created on elements where the attribute is accepted.
+     */
+    private _isRangeToUpdate;
+    /**
+     * Updates selected link with a new value as its content and as its href attribute.
+     *
+     * @param model Model is need to insert content.
+     * @param writer Writer is need to create text element in model.
+     * @param range A range where should be inserted content.
+     * @param href A link value which should be in the href attribute and in the content.
+     */
+    private _updateLinkContent;
+}

package/dist/types/linkconfig.d.ts

@@ -0,0 +1,290 @@
+/**
+ * @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 link/linkconfig
+ */
+import type { ArrayOrItem } from 'ckeditor5/src/utils.js';
+/**
+ * The configuration of the {@link module:link/link~Link link feature}.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		link:  ... // Link feature configuration.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface LinkConfig {
+    /**
+     * When set, the editor will add the given protocol to the link when the user creates a link without one.
+     * For example, when the user is creating a link and types `ckeditor.com` in the link form input, during link submission
+     * the editor will automatically add the `http://` protocol, so the link will look as follows: `http://ckeditor.com`.
+     *
+     * The feature also provides email address auto-detection. When you submit `hello@example.com`,
+     * the plugin will automatically change it to `mailto:hello@example.com`.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		link: {
+     * 			defaultProtocol: 'http://'
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * **NOTE:** If no configuration is provided, the editor will not auto-fix the links.
+     */
+    defaultProtocol?: string;
+    /**
+     * This is a protocols whitelist that can be used in links, defined as an array of strings.
+     * When not set, the editor will use a default list of allowed protocols.
+     *
+     * **Note:** Use this with caution and at your own risk - adding unsafe protocols like `javascript:`
+     * can result in serious security vulnerabilities!
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		link: {
+     * 			allowedProtocols: [ 'http', 'https', 'ftp', 'tel', 'mailto', 'ssh' ]
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     */
+    allowedProtocols?: Array<string>;
+    /**
+     * When set to `true`, the form will accept an empty value in the URL field, creating a link with an empty `href` (`<a href="">`).
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		link: {
+     * 			allowCreatingEmptyLinks: true
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * **NOTE:** This option only adds form validation. If a link with an empty `href` is loaded into the editor, it will be left as-is.
+     *
+     * @default false
+     */
+    allowCreatingEmptyLinks?: boolean;
+    /**
+     * When set to `true`, the `target="blank"` and `rel="noopener noreferrer"` attributes are automatically added to all external links
+     * in the editor. "External links" are all links in the editor content starting with `http`, `https`, or `//`.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		link: {
+     * 			addTargetToExternalLinks: true
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * Internally, this option activates a predefined {@link module:link/linkconfig~LinkConfig#decorators automatic link decorator}
+     * that extends all external links with the `target` and `rel` attributes.
+     *
+     * **Note**: To control the `target` and `rel` attributes of specific links in the edited content, a dedicated
+     * {@link module:link/linkconfig~LinkDecoratorManualDefinition manual} decorator must be defined in the
+     * {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} array. In such scenario,
+     * the `config.link.addTargetToExternalLinks` option should remain `undefined` or `false` to not interfere with the manual decorator.
+     *
+     * It is possible to add other {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic}
+     * or {@link module:link/linkconfig~LinkDecoratorManualDefinition manual} link decorators when this option is active.
+     *
+     * More information about decorators can be found in the {@link module:link/linkconfig~LinkConfig#decorators decorators configuration}
+     * reference.
+     *
+     * @default false
+     */
+    addTargetToExternalLinks?: boolean;
+    /**
+     * Decorators provide an easy way to configure and manage additional link attributes in the editor content. There are
+     * two types of link decorators:
+     *
+     * * {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition Automatic} &ndash; They match links against pre–defined rules and
+     * manage their attributes based on the results.
+     * * {@link module:link/linkconfig~LinkDecoratorManualDefinition Manual} &ndash; They allow users to control link attributes
+     * individually, using the editor UI.
+     *
+     * Link decorators are defined as objects with key-value pairs, where the key is the name provided for a given decorator and the
+     * value is the decorator definition.
+     *
+     * The name of the decorator also corresponds to the {@glink framework/architecture/editing-engine#text-attributes text
+     * attribute} in the model. For instance, the `isExternal` decorator below is represented as a `linkIsExternal` attribute in the model.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( editorElement, {
+     * 		link: {
+     * 			decorators: {
+     * 				isExternal: {
+     * 					mode: 'automatic',
+     * 					callback: url => url.startsWith( 'http://' ),
+     * 					attributes: {
+     * 						target: '_blank',
+     * 						rel: 'noopener noreferrer'
+     * 					}
+     * 				},
+     * 				isDownloadable: {
+     * 					mode: 'manual',
+     * 					label: 'Downloadable',
+     * 					attributes: {
+     * 						download: 'file.png',
+     * 					}
+     * 				},
+     * 				// ...
+     * 			}
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     *
+     * To learn more about the configuration syntax, check out the {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic}
+     * and {@link module:link/linkconfig~LinkDecoratorManualDefinition manual} decorator option reference.
+     *
+     * **Warning:** Currently, link decorators work independently of one another and no conflict resolution mechanism exists.
+     * For example, configuring the `target` attribute using both an automatic and a manual decorator at the same time could end up with
+     * quirky results. The same applies if multiple manual or automatic decorators were defined for the same attribute.
+     *
+     * **Note**: Since the `target` attribute management for external links is a common use case, there is a predefined automatic decorator
+     * dedicated for that purpose which can be enabled by turning a single option on. Check out the
+     * {@link module:link/linkconfig~LinkConfig#addTargetToExternalLinks `config.link.addTargetToExternalLinks`}
+     * configuration description to learn more.
+     *
+     * See also the {@glink features/link#custom-link-attributes-decorators link feature guide} for more information.
+     */
+    decorators?: Record<string, LinkDecoratorDefinition>;
+}
+/**
+ * A link decorator definition. Two types implement this definition:
+ *
+ * * {@link module:link/linkconfig~LinkDecoratorManualDefinition}
+ * * {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition}
+ *
+ * Refer to their document for more information about available options or to the
+ * {@glink features/link#custom-link-attributes-decorators link feature guide} for general information.
+ */
+export type LinkDecoratorDefinition = LinkDecoratorAutomaticDefinition | LinkDecoratorManualDefinition;
+/**
+ * Describes an automatic {@link module:link/linkconfig~LinkConfig#decorators link decorator}. This decorator type matches
+ * all links in the editor content against a function that decides whether the link should receive a pre–defined set of attributes.
+ *
+ * It takes an object with key-value pairs of attributes and a callback function that must return a Boolean value based on the link's
+ * `href` (URL). When the callback returns `true`, attributes are applied to the link.
+ *
+ * For example, to add the `target="_blank"` attribute to all links in the editor starting with `http://`, the
+ * configuration could look like this:
+ *
+ * ```ts
+ * {
+ * 	mode: 'automatic',
+ * 	callback: url => url.startsWith( 'http://' ),
+ * 	attributes: {
+ * 		target: '_blank'
+ * 	}
+ * }
+ * ```
+ *
+ * **Note**: Since the `target` attribute management for external links is a common use case, there is a predefined automatic decorator
+ * dedicated for that purpose that can be enabled by turning a single option on. Check out the
+ * {@link module:link/linkconfig~LinkConfig#addTargetToExternalLinks `config.link.addTargetToExternalLinks`}
+ * configuration description to learn more.
+ */
+export interface LinkDecoratorAutomaticDefinition {
+    /**
+     * Link decorator type. It is `'automatic'` for all automatic decorators.
+     */
+    mode: 'automatic';
+    /**
+     * Takes a `url` as a parameter and returns `true` if the `attributes` should be applied to the link.
+     */
+    callback: (url: string | null) => boolean;
+    /**
+     * Key-value pairs used as link attributes added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Attributes should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    attributes?: Record<string, string>;
+    /**
+     * Key-value pairs used as link styles added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Styles should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    styles?: Record<string, string>;
+    /**
+     * Class names used as link classes added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Classes should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    classes?: ArrayOrItem<string>;
+}
+/**
+ * Describes a manual {@link module:link/linkconfig~LinkConfig#decorators link decorator}. This decorator type is represented in
+ * the link feature's {@link module:link/linkui user interface} as a switch that the user can use to control the presence
+ * of a predefined set of attributes.
+ *
+ * For instance, to allow the users to manually control the presence of the `target="_blank"` and
+ * `rel="noopener noreferrer"` attributes on specific links, the decorator could look as follows:
+ *
+ * ```ts
+ * {
+ * 	mode: 'manual',
+ * 	label: 'Open in a new tab',
+ * 	defaultValue: true,
+ * 	attributes: {
+ * 		target: '_blank',
+ * 		rel: 'noopener noreferrer'
+ * 	}
+ * }
+ * ```
+ */
+export interface LinkDecoratorManualDefinition {
+    /**
+     * Link decorator type. It is `'manual'` for all manual decorators.
+     */
+    mode: 'manual';
+    /**
+     * The label of the UI button that the user can use to control the presence of link attributes.
+     */
+    label: string;
+    /**
+     * Key-value pairs used as link attributes added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Attributes should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    attributes?: Record<string, string>;
+    /**
+     * Key-value pairs used as link styles added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Styles should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    styles?: Record<string, string>;
+    /**
+     * Class names used as link classes added to the output during the
+     * {@glink framework/architecture/editing-engine#conversion downcasting}.
+     * Classes should follow the {@link module:engine/view/elementdefinition~ElementDefinition} syntax.
+     */
+    classes?: ArrayOrItem<string>;
+    /**
+     * Controls whether the decorator is "on" by default.
+     */
+    defaultValue?: boolean;
+}

package/dist/types/linkediting.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @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 link/linkediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Input, TwoStepCaretMovement } from 'ckeditor5/src/typing.js';
+import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
+import '../theme/link.css';
+/**
+ * The link engine feature.
+ *
+ * It introduces the `linkHref="url"` attribute in the model which renders to the view as a `<a href="url">` element
+ * as well as `'link'` and `'unlink'` commands.
+ */
+export default class LinkEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LinkEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TwoStepCaretMovement, typeof Input, typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Processes an array of configured {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic decorators}
+     * and registers a {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher downcast dispatcher}
+     * for each one of them. Downcast dispatchers are obtained using the
+     * {@link module:link/utils/automaticdecorators~AutomaticDecorators#getDispatcher} method.
+     *
+     * **Note**: This method also activates the automatic external link decorator if enabled with
+     * {@link module:link/linkconfig~LinkConfig#addTargetToExternalLinks `config.link.addTargetToExternalLinks`}.
+     */
+    private _enableAutomaticDecorators;
+    /**
+     * Processes an array of configured {@link module:link/linkconfig~LinkDecoratorManualDefinition manual decorators},
+     * transforms them into {@link module:link/utils/manualdecorator~ManualDecorator} instances and stores them in the
+     * {@link module:link/linkcommand~LinkCommand#manualDecorators} collection (a model for manual decorators state).
+     *
+     * Also registers an {@link module:engine/conversion/downcasthelpers~DowncastHelpers#attributeToElement attribute-to-element}
+     * converter for each manual decorator and extends the {@link module:engine/model/schema~Schema model's schema}
+     * with adequate model attributes.
+     */
+    private _enableManualDecorators;
+    /**
+     * Attaches handlers for {@link module:engine/view/document~Document#event:enter} and
+     * {@link module:engine/view/document~Document#event:click} to enable link following.
+     */
+    private _enableLinkOpen;
+    /**
+     * Watches the DocumentSelection attribute changes and removes link decorator attributes when the linkHref attribute is removed.
+     *
+     * This is to ensure that there is no left-over link decorator attributes on the document selection that is no longer in a link.
+     */
+    private _enableSelectionAttributesFixer;
+    /**
+     * Enables URL fixing on pasting.
+     */
+    private _enableClipboardIntegration;
+}

package/dist/types/linkimage.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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 link/linkimage
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import LinkImageEditing from './linkimageediting.js';
+import LinkImageUI from './linkimageui.js';
+import '../theme/linkimage.css';
+/**
+ * The `LinkImage` plugin.
+ *
+ * This is a "glue" plugin that loads the {@link module:link/linkimageediting~LinkImageEditing link image editing feature}
+ * and {@link module:link/linkimageui~LinkImageUI link image UI feature}.
+ */
+export default class LinkImage extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof LinkImageEditing, typeof LinkImageUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "LinkImage";
+}