@ckeditor/ckeditor5-link 36.0.1 → 37.0.0-alpha.1

package/src/autolink.js

@@ -2,284 +2,215 @@
  * @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' );
-
+// 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.
- *
- * @extends module:core/plugin~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.
-	 *
-	 * @private
-	 */
-	_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.
-	 *
-	 * @private
-	 */
-	_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.
-	 *
-	 * @private
-	 */
-	_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.
-	 *
-	 * @param {module:engine/model/range~Range} rangeToCheck
-	 * @private
-	 */
-	_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 {String} url The URL to link.
-	 * @param {module:engine/model/range~Range} range The text range to apply the link attribute to.
-	 * @private
-	 */
-	_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 {String} url The URL to link.
-	 * @param {module:engine/model/range~Range} range The text range to apply the link attribute to.
-	 * @protected
-	 */
-	_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();
-			} );
-		} );
-	}
+    /**
+     * @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 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 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 isLinkAllowedOnRange(range, model) {
+    return model.schema.checkAttributeInSelection(model.createSelection(range), 'linkHref');
 }
-
-function linkIsAlreadySet( range ) {
-	const item = range.start.nodeAfter;
-	return item && item.hasAttribute( 'linkHref' );
+function linkIsAlreadySet(range) {
+    const item = range.start.nodeAfter;
+    return !!item && item.hasAttribute('linkHref');
 }

package/src/index.d.ts

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

package/src/index.js

@@ -2,11 +2,9 @@
  * @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
  */
-
 export { default as Link } from './link';
 export { default as LinkEditing } from './linkediting';
 export { default as LinkUI } from './linkui';
@@ -14,3 +12,6 @@ export { default as LinkImage } from './linkimage';
 export { default as LinkImageEditing } from './linkimageediting';
 export { default as LinkImageUI } from './linkimageui';
 export { default as AutoLink } from './autolink';
+export { default as LinkCommand } from './linkcommand';
+export { default as UnlinkCommand } from './unlinkcommand';
+import './augmentation';

package/src/link.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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/link
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * 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(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Link';
+}