@ckeditor/ckeditor5-link 38.1.1 → 38.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-link",
-  "version": "38.1.1",
+  "version": "38.2.0-alpha.1",
   "description": "Link feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,9 +11,10 @@
     "ckeditor5-dll"
   ],
   "main": "src/index.js",
+  "type": "module",
   "dependencies": {
-    "@ckeditor/ckeditor5-ui": "38.1.1",
-    "ckeditor5": "38.1.1",
+    "@ckeditor/ckeditor5-ui": "38.2.0-alpha.1",
+    "ckeditor5": "38.2.0-alpha.1",
     "lodash-es": "^4.17.15"
   },
   "engines": {

package/src/augmentation.d.ts

@@ -1,30 +1,30 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-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;
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-export {};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/autolink.d.ts

@@ -1,60 +1,60 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-import { Delete } from 'ckeditor5/src/typing';
-/**
- * The autolink plugin.
- */
-export default class AutoLink extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Delete];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AutoLink";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * 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;
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+/**
+ * The autolink plugin.
+ */
+export default class AutoLink extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Delete];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AutoLink";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * 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/src/autolink.js

@@ -1,216 +1,216 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-import { Delete, TextWatcher, getLastTextLine } from 'ckeditor5/src/typing';
-import { addLinkProtocolIfApplicable, linkHasProtocol } from './utils';
-const MIN_LINK_LENGTH_WITH_SPACE_AT_END = 4; // Ie: "t.co " (length 5).
-// This was a tweak from https://gist.github.com/dperini/729294.
-const URL_REG_EXP = new RegExp(
-// Group 1: Line start or after a space.
-'(^|\\s)' +
-    // Group 2: Detected URL (or e-mail).
-    '(' +
-    // Protocol identifier or short syntax "//"
-    // a. Full form http://user@foo.bar.baz:8080/foo/bar.html#baz?foo=bar
-    '(' +
-    '(?:(?:(?:https?|ftp):)?\\/\\/)' +
-    // BasicAuth using user:pass (optional)
-    '(?:\\S+(?::\\S*)?@)?' +
-    '(?:' +
-    // IP address dotted notation octets
-    // excludes loopback network 0.0.0.0
-    // excludes reserved space >= 224.0.0.0
-    // excludes network & broadcast addresses
-    // (first & last IP address of each class)
-    '(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])' +
-    '(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}' +
-    '(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))' +
-    '|' +
-    '(' +
-    // Do not allow `www.foo` - see https://github.com/ckeditor/ckeditor5/issues/8050.
-    '((?!www\\.)|(www\\.))' +
-    // Host & domain names.
-    '(?![-_])(?:[-_a-z0-9\\u00a1-\\uffff]{1,63}\\.)+' +
-    // TLD identifier name.
-    '(?:[a-z\\u00a1-\\uffff]{2,63})' +
-    ')' +
-    ')' +
-    // port number (optional)
-    '(?::\\d{2,5})?' +
-    // resource path (optional)
-    '(?:[/?#]\\S*)?' +
-    ')' +
-    '|' +
-    // b. Short form (either www.example.com or example@example.com)
-    '(' +
-    '(www.|(\\S+@))' +
-    // Host & domain names.
-    '((?![-_])(?:[-_a-z0-9\\u00a1-\\uffff]{1,63}\\.))+' +
-    // TLD identifier name.
-    '(?:[a-z\\u00a1-\\uffff]{2,63})' +
-    ')' +
-    ')$', 'i');
-const URL_GROUP_IN_MATCH = 2;
-/**
- * The autolink plugin.
- */
-export default class AutoLink extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Delete];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'AutoLink';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const selection = editor.model.document.selection;
-        selection.on('change:range', () => {
-            // Disable plugin when selection is inside a code block.
-            this.isEnabled = !selection.anchor.parent.is('element', 'codeBlock');
-        });
-        this._enableTypingHandling();
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        this._enableEnterHandling();
-        this._enableShiftEnterHandling();
-    }
-    /**
-     * Enables autolinking on typing.
-     */
-    _enableTypingHandling() {
-        const editor = this.editor;
-        const watcher = new TextWatcher(editor.model, text => {
-            // 1. Detect <kbd>Space</kbd> after a text with a potential link.
-            if (!isSingleSpaceAtTheEnd(text)) {
-                return;
-            }
-            // 2. Check text before last typed <kbd>Space</kbd>.
-            const url = getUrlAtTextEnd(text.substr(0, text.length - 1));
-            if (url) {
-                return { url };
-            }
-        });
-        watcher.on('matched:data', (evt, data) => {
-            const { batch, range, url } = data;
-            if (!batch.isTyping) {
-                return;
-            }
-            const linkEnd = range.end.getShiftedBy(-1); // Executed after a space character.
-            const linkStart = linkEnd.getShiftedBy(-url.length);
-            const linkRange = editor.model.createRange(linkStart, linkEnd);
-            this._applyAutoLink(url, linkRange);
-        });
-        watcher.bind('isEnabled').to(this);
-    }
-    /**
-     * Enables autolinking on the <kbd>Enter</kbd> key.
-     */
-    _enableEnterHandling() {
-        const editor = this.editor;
-        const model = editor.model;
-        const enterCommand = editor.commands.get('enter');
-        if (!enterCommand) {
-            return;
-        }
-        enterCommand.on('execute', () => {
-            const position = model.document.selection.getFirstPosition();
-            if (!position.parent.previousSibling) {
-                return;
-            }
-            const rangeToCheck = model.createRangeIn(position.parent.previousSibling);
-            this._checkAndApplyAutoLinkOnRange(rangeToCheck);
-        });
-    }
-    /**
-     * Enables autolinking on the <kbd>Shift</kbd>+<kbd>Enter</kbd> keyboard shortcut.
-     */
-    _enableShiftEnterHandling() {
-        const editor = this.editor;
-        const model = editor.model;
-        const shiftEnterCommand = editor.commands.get('shiftEnter');
-        if (!shiftEnterCommand) {
-            return;
-        }
-        shiftEnterCommand.on('execute', () => {
-            const position = model.document.selection.getFirstPosition();
-            const rangeToCheck = model.createRange(model.createPositionAt(position.parent, 0), position.getShiftedBy(-1));
-            this._checkAndApplyAutoLinkOnRange(rangeToCheck);
-        });
-    }
-    /**
-     * Checks if the passed range contains a linkable text.
-     */
-    _checkAndApplyAutoLinkOnRange(rangeToCheck) {
-        const model = this.editor.model;
-        const { text, range } = getLastTextLine(rangeToCheck, model);
-        const url = getUrlAtTextEnd(text);
-        if (url) {
-            const linkRange = model.createRange(range.end.getShiftedBy(-url.length), range.end);
-            this._applyAutoLink(url, linkRange);
-        }
-    }
-    /**
-     * 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.
-     */
-    _applyAutoLink(url, range) {
-        const model = this.editor.model;
-        const defaultProtocol = this.editor.config.get('link.defaultProtocol');
-        const fullUrl = addLinkProtocolIfApplicable(url, defaultProtocol);
-        if (!this.isEnabled || !isLinkAllowedOnRange(range, model) || !linkHasProtocol(fullUrl) || linkIsAlreadySet(range)) {
-            return;
-        }
-        this._persistAutoLink(fullUrl, range);
-    }
-    /**
-     * Enqueues autolink changes in the model.
-     *
-     * @param url The URL to link.
-     * @param range The text range to apply the link attribute to.
-     */
-    _persistAutoLink(url, range) {
-        const model = this.editor.model;
-        const deletePlugin = this.editor.plugins.get('Delete');
-        // Enqueue change to make undo step.
-        model.enqueueChange(writer => {
-            writer.setAttribute('linkHref', url, range);
-            model.enqueueChange(() => {
-                deletePlugin.requestUndoOnBackspace();
-            });
-        });
-    }
-}
-// Check if text should be evaluated by the plugin in order to reduce number of RegExp checks on whole text.
-function isSingleSpaceAtTheEnd(text) {
-    return text.length > MIN_LINK_LENGTH_WITH_SPACE_AT_END && text[text.length - 1] === ' ' && text[text.length - 2] !== ' ';
-}
-function getUrlAtTextEnd(text) {
-    const match = URL_REG_EXP.exec(text);
-    return match ? match[URL_GROUP_IN_MATCH] : null;
-}
-function isLinkAllowedOnRange(range, model) {
-    return model.schema.checkAttributeInSelection(model.createSelection(range), 'linkHref');
-}
-function linkIsAlreadySet(range) {
-    const item = range.start.nodeAfter;
-    return !!item && item.hasAttribute('linkHref');
-}
+/**
+ * @license Copyright (c) 2003-2023, 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, TextWatcher, getLastTextLine } from 'ckeditor5/src/typing.js';
+import { addLinkProtocolIfApplicable, linkHasProtocol } from './utils.js';
+const MIN_LINK_LENGTH_WITH_SPACE_AT_END = 4; // Ie: "t.co " (length 5).
+// This was a tweak from https://gist.github.com/dperini/729294.
+const URL_REG_EXP = new RegExp(
+// Group 1: Line start or after a space.
+'(^|\\s)' +
+    // Group 2: Detected URL (or e-mail).
+    '(' +
+    // Protocol identifier or short syntax "//"
+    // a. Full form http://user@foo.bar.baz:8080/foo/bar.html#baz?foo=bar
+    '(' +
+    '(?:(?:(?:https?|ftp):)?\\/\\/)' +
+    // BasicAuth using user:pass (optional)
+    '(?:\\S+(?::\\S*)?@)?' +
+    '(?:' +
+    // IP address dotted notation octets
+    // excludes loopback network 0.0.0.0
+    // excludes reserved space >= 224.0.0.0
+    // excludes network & broadcast addresses
+    // (first & last IP address of each class)
+    '(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])' +
+    '(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}' +
+    '(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))' +
+    '|' +
+    '(' +
+    // Do not allow `www.foo` - see https://github.com/ckeditor/ckeditor5/issues/8050.
+    '((?!www\\.)|(www\\.))' +
+    // Host & domain names.
+    '(?![-_])(?:[-_a-z0-9\\u00a1-\\uffff]{1,63}\\.)+' +
+    // TLD identifier name.
+    '(?:[a-z\\u00a1-\\uffff]{2,63})' +
+    ')' +
+    ')' +
+    // port number (optional)
+    '(?::\\d{2,5})?' +
+    // resource path (optional)
+    '(?:[/?#]\\S*)?' +
+    ')' +
+    '|' +
+    // b. Short form (either www.example.com or example@example.com)
+    '(' +
+    '(www.|(\\S+@))' +
+    // Host & domain names.
+    '((?![-_])(?:[-_a-z0-9\\u00a1-\\uffff]{1,63}\\.))+' +
+    // TLD identifier name.
+    '(?:[a-z\\u00a1-\\uffff]{2,63})' +
+    ')' +
+    ')$', 'i');
+const URL_GROUP_IN_MATCH = 2;
+/**
+ * The autolink plugin.
+ */
+export default class AutoLink extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Delete];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'AutoLink';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const selection = editor.model.document.selection;
+        selection.on('change:range', () => {
+            // Disable plugin when selection is inside a code block.
+            this.isEnabled = !selection.anchor.parent.is('element', 'codeBlock');
+        });
+        this._enableTypingHandling();
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        this._enableEnterHandling();
+        this._enableShiftEnterHandling();
+    }
+    /**
+     * Enables autolinking on typing.
+     */
+    _enableTypingHandling() {
+        const editor = this.editor;
+        const watcher = new TextWatcher(editor.model, text => {
+            // 1. Detect <kbd>Space</kbd> after a text with a potential link.
+            if (!isSingleSpaceAtTheEnd(text)) {
+                return;
+            }
+            // 2. Check text before last typed <kbd>Space</kbd>.
+            const url = getUrlAtTextEnd(text.substr(0, text.length - 1));
+            if (url) {
+                return { url };
+            }
+        });
+        watcher.on('matched:data', (evt, data) => {
+            const { batch, range, url } = data;
+            if (!batch.isTyping) {
+                return;
+            }
+            const linkEnd = range.end.getShiftedBy(-1); // Executed after a space character.
+            const linkStart = linkEnd.getShiftedBy(-url.length);
+            const linkRange = editor.model.createRange(linkStart, linkEnd);
+            this._applyAutoLink(url, linkRange);
+        });
+        watcher.bind('isEnabled').to(this);
+    }
+    /**
+     * Enables autolinking on the <kbd>Enter</kbd> key.
+     */
+    _enableEnterHandling() {
+        const editor = this.editor;
+        const model = editor.model;
+        const enterCommand = editor.commands.get('enter');
+        if (!enterCommand) {
+            return;
+        }
+        enterCommand.on('execute', () => {
+            const position = model.document.selection.getFirstPosition();
+            if (!position.parent.previousSibling) {
+                return;
+            }
+            const rangeToCheck = model.createRangeIn(position.parent.previousSibling);
+            this._checkAndApplyAutoLinkOnRange(rangeToCheck);
+        });
+    }
+    /**
+     * Enables autolinking on the <kbd>Shift</kbd>+<kbd>Enter</kbd> keyboard shortcut.
+     */
+    _enableShiftEnterHandling() {
+        const editor = this.editor;
+        const model = editor.model;
+        const shiftEnterCommand = editor.commands.get('shiftEnter');
+        if (!shiftEnterCommand) {
+            return;
+        }
+        shiftEnterCommand.on('execute', () => {
+            const position = model.document.selection.getFirstPosition();
+            const rangeToCheck = model.createRange(model.createPositionAt(position.parent, 0), position.getShiftedBy(-1));
+            this._checkAndApplyAutoLinkOnRange(rangeToCheck);
+        });
+    }
+    /**
+     * Checks if the passed range contains a linkable text.
+     */
+    _checkAndApplyAutoLinkOnRange(rangeToCheck) {
+        const model = this.editor.model;
+        const { text, range } = getLastTextLine(rangeToCheck, model);
+        const url = getUrlAtTextEnd(text);
+        if (url) {
+            const linkRange = model.createRange(range.end.getShiftedBy(-url.length), range.end);
+            this._applyAutoLink(url, linkRange);
+        }
+    }
+    /**
+     * 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.
+     */
+    _applyAutoLink(url, range) {
+        const model = this.editor.model;
+        const defaultProtocol = this.editor.config.get('link.defaultProtocol');
+        const fullUrl = addLinkProtocolIfApplicable(url, defaultProtocol);
+        if (!this.isEnabled || !isLinkAllowedOnRange(range, model) || !linkHasProtocol(fullUrl) || linkIsAlreadySet(range)) {
+            return;
+        }
+        this._persistAutoLink(fullUrl, range);
+    }
+    /**
+     * Enqueues autolink changes in the model.
+     *
+     * @param url The URL to link.
+     * @param range The text range to apply the link attribute to.
+     */
+    _persistAutoLink(url, range) {
+        const model = this.editor.model;
+        const deletePlugin = this.editor.plugins.get('Delete');
+        // Enqueue change to make undo step.
+        model.enqueueChange(writer => {
+            writer.setAttribute('linkHref', url, range);
+            model.enqueueChange(() => {
+                deletePlugin.requestUndoOnBackspace();
+            });
+        });
+    }
+}
+// Check if text should be evaluated by the plugin in order to reduce number of RegExp checks on whole text.
+function isSingleSpaceAtTheEnd(text) {
+    return text.length > MIN_LINK_LENGTH_WITH_SPACE_AT_END && text[text.length - 1] === ' ' && text[text.length - 2] !== ' ';
+}
+function getUrlAtTextEnd(text) {
+    const match = URL_REG_EXP.exec(text);
+    return match ? match[URL_GROUP_IN_MATCH] : null;
+}
+function isLinkAllowedOnRange(range, model) {
+    return model.schema.checkAttributeInSelection(model.createSelection(range), 'linkHref');
+}
+function linkIsAlreadySet(range) {
+    const item = range.start.nodeAfter;
+    return !!item && item.hasAttribute('linkHref');
+}