@ckeditor/ckeditor5-link 45.2.1 → 46.0.0-alpha.1

package/dist/index.js

@@ -6,7 +6,7 @@ import { Command, Plugin } from '@ckeditor/ckeditor5-core/dist/index.js';
 import { findAttributeRange, TwoStepCaretMovement, Input, inlineHighlight, Delete, TextWatcher, getLastTextLine } from '@ckeditor/ckeditor5-typing/dist/index.js';
 import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard/dist/index.js';
 import { toMap, Collection, first, diff, ObservableMixin, env, keyCodes, FocusTracker, KeystrokeHandler } from '@ckeditor/ckeditor5-utils/dist/index.js';
-import { LivePosition, ClickObserver, Matcher } from '@ckeditor/ckeditor5-engine/dist/index.js';
+import { ModelLivePosition, ClickObserver, Matcher } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { upperFirst } from 'es-toolkit/compat';
 import { IconPreviousArrow, IconUnlink, IconPencil, IconSettings, IconLink } from '@ckeditor/ckeditor5-icons/dist/index.js';
 import { ButtonView, View, ViewCollection, FocusCycler, submitHandler, FormHeaderView, ListView, ListItemView, LabeledFieldView, createLabeledInputText, FormRowView, IconView, ContextualBalloon, ToolbarView, CssTransitionDisablerMixin, SwitchButtonView, MenuBarMenuListItemButtonView, clickOutsideHandler } from '@ckeditor/ckeditor5-ui/dist/index.js';
@@ -16,13 +16,13 @@ import { IconPreviousArrow as IconPreviousArrow$1, IconNextArrow } from '@ckedit
 /**
  * Helper class that ties together all {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition} and provides
  * the {@link module:engine/conversion/downcasthelpers~DowncastHelpers#attributeToElement downcast dispatchers} for them.
- */ class AutomaticDecorators {
+ */ class AutomaticLinkDecorators {
     /**
 	 * Stores the definition of {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic decorators}.
 	 * This data is used as a source for a downcast dispatcher to create a proper conversion to output data.
 	 */ _definitions = new Set();
     /**
-	 * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticDecorators}
+	 * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticLinkDecorators}
 	 * instance.
 	 */ get length() {
         return this._definitions.size;
@@ -160,7 +160,7 @@ const DEFAULT_LINK_PROTOCOLS = [
     return node.is('attributeElement') && !!node.getCustomProperty('link');
 }
 /**
- * Creates a link {@link module:engine/view/attributeelement~AttributeElement} with the provided `href` attribute.
+ * Creates a link {@link module:engine/view/attributeelement~ViewAttributeElement} with the provided `href` attribute.
  */ function createLinkElement(href, { writer }) {
     // Priority 5 - https://github.com/ckeditor/ckeditor5-link/issues/121.
     const linkElement = writer.createAttributeElement('a', {
@@ -201,6 +201,7 @@ const DEFAULT_LINK_PROTOCOLS = [
  *
  * @param t Shorthand for {@link module:utils/locale~Locale#t Locale#t}.
  * @param decorators The decorator reference where the label values should be localized.
+ * @internal
  */ function getLocalizedDecorators(t, decorators) {
     const localizedDecoratorsLabels = {
         'Open in a new tab': t('Open in a new tab'),
@@ -217,6 +218,8 @@ const DEFAULT_LINK_PROTOCOLS = [
 /**
  * Converts an object with defined decorators to a normalized array of decorators. The `id` key is added for each decorator and
  * is used as the attribute's name in the model.
+ *
+ * @internal
  */ function normalizeDecorators(decorators) {
     const retArray = [];
     if (decorators) {
@@ -239,6 +242,8 @@ const DEFAULT_LINK_PROTOCOLS = [
 }
 /**
  * Returns `true` if the specified `value` is an email.
+ *
+ * @internal
  */ function isEmail(value) {
     return EMAIL_REG_EXP.test(value);
 }
@@ -255,6 +260,8 @@ const DEFAULT_LINK_PROTOCOLS = [
 }
 /**
  * Checks if protocol is already included in the link.
+ *
+ * @internal
  */ function linkHasProtocol(link) {
     return PROTOCOL_REG_EXP.test(link);
 }
@@ -282,7 +289,7 @@ const DEFAULT_LINK_PROTOCOLS = [
  * The link command. It is used by the {@link module:link/link~Link link feature}.
  */ class LinkCommand extends Command {
     /**
-	 * A collection of {@link module:link/utils/manualdecorator~ManualDecorator manual decorators}
+	 * A collection of {@link module:link/utils/manualdecorator~LinkManualDecorator 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.
@@ -290,7 +297,7 @@ const DEFAULT_LINK_PROTOCOLS = [
     /**
 	 * 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.
-	 */ automaticDecorators = new AutomaticDecorators();
+	 */ automaticDecorators = new AutomaticLinkDecorators();
     /**
 	 * Synchronizes the state of {@link #manualDecorators} with the currently present elements in the model.
 	 */ restoreManualDecoratorStates() {
@@ -324,7 +331,7 @@ const DEFAULT_LINK_PROTOCOLS = [
 	 * 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
+	 * new {@link module:engine/model/text~ModelText 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.
 	 *
@@ -334,7 +341,7 @@ const DEFAULT_LINK_PROTOCOLS = [
 	 *
 	 * 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}.
+	 * {@link module:link/utils/manualdecorator~LinkManualDecorator manual link decorators}.
 	 *
 	 * Text attribute names in the model correspond to the entries in the {@link module:link/linkconfig~LinkConfig#decorators
 	 * configuration}.
@@ -523,8 +530,8 @@ const DEFAULT_LINK_PROTOCOLS = [
                 }
                 // Store the selection ranges in a pseudo live range array (stickiness to the outside of the range).
                 const stickyPseudoRanges = selectionRanges.map((range)=>({
-                        start: LivePosition.fromPosition(range.start, 'toPrevious'),
-                        end: LivePosition.fromPosition(range.end, 'toNext')
+                        start: ModelLivePosition.fromPosition(range.start, 'toPrevious'),
+                        end: ModelLivePosition.fromPosition(range.end, 'toNext')
                     }));
                 // Update or set links (including text update if needed).
                 for (let range of rangesToUpdate){
@@ -723,10 +730,10 @@ const DEFAULT_LINK_PROTOCOLS = [
 }
 
 /**
- * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~ManualDecorator#value}
+ * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~LinkManualDecorator#value}
  * to support integration with the UI state. An instance of this class is a model with the state of individual manual decorators.
  * These decorators are kept as collections in {@link module:link/linkcommand~LinkCommand#manualDecorators}.
- */ class ManualDecorator extends /* #__PURE__ */ ObservableMixin() {
+ */ class LinkManualDecorator extends /* #__PURE__ */ ObservableMixin() {
     /**
 	 * An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
 	 */ id;
@@ -738,18 +745,18 @@ const DEFAULT_LINK_PROTOCOLS = [
 	 */ label;
     /**
 	 * A set of attributes added to downcasted data when the decorator is activated for a specific link.
-	 * Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+	 * Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
 	 */ attributes;
     /**
 	 * A set of classes added to downcasted data when the decorator is activated for a specific link.
-	 * Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+	 * Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
 	 */ classes;
     /**
 	 * A set of styles added to downcasted data when the decorator is activated for a specific link.
-	 * Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
+	 * Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
 	 */ styles;
     /**
-	 * Creates a new instance of {@link module:link/utils/manualdecorator~ManualDecorator}.
+	 * Creates a new instance of {@link module:link/utils/manualdecorator~LinkManualDecorator}.
 	 *
 	 * @param options The configuration object.
 	 */ constructor({ id, label, attributes, classes, styles, defaultValue }){
@@ -868,7 +875,7 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
         inlineHighlight(editor, 'linkHref', 'a', HIGHLIGHT_CLASS);
         // Handle link following by CTRL+click or ALT+ENTER
         this._enableLinkOpen();
-        // Clears the DocumentSelection decorator attributes if the selection is no longer in a link (for example while using 2-SCM).
+        // Clears the ModelDocumentSelection decorator attributes if the selection is no longer in a link (for example while using 2-SCM).
         this._enableSelectionAttributesFixer();
         // Handle adding default protocol to pasted links.
         this._enableClipboardIntegration();
@@ -885,7 +892,7 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
 	 * 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.
+	 * {@link module:link/utils/automaticdecorators~AutomaticLinkDecorators#getDispatcher} method.
 	 *
 	 * **Note**: This method also activates the automatic external link decorator if enabled with
 	 * {@link module:link/linkconfig~LinkConfig#addTargetToExternalLinks `config.link.addTargetToExternalLinks`}.
@@ -914,11 +921,11 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
     }
     /**
 	 * 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
+	 * transforms them into {@link module:link/utils/manualdecorator~LinkManualDecorator} 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}
+	 * converter for each manual decorator and extends the {@link module:engine/model/schema~ModelSchema model's schema}
 	 * with adequate model attributes.
 	 */ _enableManualDecorators(manualDecoratorDefinitions) {
         if (!manualDecoratorDefinitions.length) {
@@ -932,7 +939,7 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
                 allowAttributes: decoratorDefinition.id
             });
             // Keeps reference to manual decorator to decode its name to attributes during downcast.
-            const decorator = new ManualDecorator(decoratorDefinition);
+            const decorator = new LinkManualDecorator(decoratorDefinition);
             manualDecorators.add(decorator);
             editor.conversion.for('downcast').attributeToElement({
                 model: decorator.id,
@@ -968,8 +975,8 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
         });
     }
     /**
-	 * Attaches handlers for {@link module:engine/view/document~Document#event:enter} and
-	 * {@link module:engine/view/document~Document#event:click} to enable link following.
+	 * Attaches handlers for {@link module:engine/view/document~ViewDocument#event:enter} and
+	 * {@link module:engine/view/document~ViewDocument#event:click} to enable link following.
 	 */ _enableLinkOpen() {
         const editor = this.editor;
         const view = editor.editing.view;
@@ -1014,7 +1021,7 @@ const EXTERNAL_LINKS_REGEXP = /^(https?:)?\/\//;
         });
     }
     /**
-	 * Watches the DocumentSelection attribute changes and removes link decorator attributes when the linkHref attribute is removed.
+	 * Watches the ModelDocumentSelection 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.
 	 */ _enableSelectionAttributesFixer() {
@@ -2591,8 +2598,8 @@ const VISUAL_SELECTION_MARKER_NAME = 'link-ui';
         };
     }
     /**
-	 * Returns the link {@link module:engine/view/attributeelement~AttributeElement} under
-	 * the {@link module:engine/view/document~Document editing view's} selection or `null`
+	 * Returns the link {@link module:engine/view/attributeelement~ViewAttributeElement} under
+	 * the {@link module:engine/view/document~ViewDocument editing view's} selection or `null`
 	 * if there is none.
 	 *
 	 * **Note**: For a non–collapsed selection, the link element is returned when **fully**
@@ -3063,7 +3070,7 @@ function linkIsAlreadySet(range) {
         }
     }
     /**
-	 * Processes transformed {@link module:link/utils/manualdecorator~ManualDecorator} instances and attaches proper converters
+	 * Processes transformed {@link module:link/utils/manualdecorator~LinkManualDecorator} instances and attaches proper converters
 	 * that will work when linking an image.
 	 */ _enableManualDecorators() {
         const editor = this.editor;
@@ -3386,5 +3393,5 @@ function linkIsAlreadySet(range) {
     }
 }
 
-export { AutoLink, Link, LinkCommand, LinkEditing, LinkFormView, LinkImage, LinkImageEditing, LinkImageUI, LinkUI, UnlinkCommand, addLinkProtocolIfApplicable, ensureSafeUrl, isLinkableElement };
+export { AutoLink, AutomaticLinkDecorators, Link, LinkCommand, LinkEditing, LinkFormView, LinkImage, LinkImageEditing, LinkImageUI, LinkManualDecorator, LinkPropertiesView, LinkProviderItemsView, LinkUI, UnlinkCommand, LINK_KEYSTROKE as _LINK_KEYSTROKE, LinkButtonView as _LinkButtonView, LinkPreviewButtonView as _LinkPreviewButtonView, createLinkElement as _createLinkElement, ensureSafeUrl as _ensureSafeLinkUrl, extractTextFromLinkRange as _extractTextFromLinkRange, getLocalizedDecorators as _getLocalizedLinkDecorators, linkHasProtocol as _hasLinkProtocol, isEmail as _isEmailLink, normalizeDecorators as _normalizeLinkDecorators, openLink as _openLink, addLinkProtocolIfApplicable, ensureSafeUrl, isLinkElement, isLinkableElement };
 //# sourceMappingURL=index.js.map