@ckeditor/ckeditor5-clipboard 35.2.1 → 35.3.0

package/src/index.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module clipboard
  */
-
 export { default as Clipboard } from './clipboard';
 export { default as ClipboardPipeline } from './clipboardpipeline';
 export { default as DragDrop } from './dragdrop';

package/src/pasteplaintext.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module clipboard/pasteplaintext
  */
-
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
-
 import ClipboardObserver from './clipboardobserver';
 import ClipboardPipeline from './clipboardpipeline';
-
 /**
  * The plugin detects the user's intention to paste plain text.
  *
@@ -20,86 +16,71 @@ import ClipboardPipeline from './clipboardpipeline';
  * @extends module:core/plugin~Plugin
  */
 export default class PastePlainText extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'PastePlainText';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ ClipboardPipeline ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const model = editor.model;
-		const view = editor.editing.view;
-		const viewDocument = view.document;
-		const selection = model.document.selection;
-
-		let shiftPressed = false;
-
-		view.addObserver( ClipboardObserver );
-
-		this.listenTo( viewDocument, 'keydown', ( evt, data ) => {
-			shiftPressed = data.shiftKey;
-		} );
-
-		editor.plugins.get( ClipboardPipeline ).on( 'contentInsertion', ( evt, data ) => {
-			// Plain text can be determined based on the event flag (#7799) or auto-detection (#1006). If detected,
-			// preserve selection attributes on pasted items.
-			if ( !shiftPressed && !isPlainTextFragment( data.content, model.schema ) ) {
-				return;
-			}
-
-			model.change( writer => {
-				// Formatting attributes should be preserved.
-				const textAttributes = Array.from( selection.getAttributes() )
-					.filter( ( [ key ] ) => model.schema.getAttributeProperties( key ).isFormatting );
-
-				if ( !selection.isCollapsed ) {
-					model.deleteContent( selection, { doNotAutoparagraph: true } );
-				}
-
-				// Also preserve other attributes if they survived the content deletion (because they were not fully selected).
-				// For example linkHref is not a formatting attribute but it should be preserved if pasted text was in the middle
-				// of a link.
-				textAttributes.push( ...selection.getAttributes() );
-
-				const range = writer.createRangeIn( data.content );
-
-				for ( const item of range.getItems() ) {
-					if ( item.is( '$textProxy' ) ) {
-						writer.setAttributes( textAttributes, item );
-					}
-				}
-			} );
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'PastePlainText';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ClipboardPipeline];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const model = editor.model;
+        const view = editor.editing.view;
+        const viewDocument = view.document;
+        const selection = model.document.selection;
+        let shiftPressed = false;
+        view.addObserver(ClipboardObserver);
+        this.listenTo(viewDocument, 'keydown', (evt, data) => {
+            shiftPressed = data.shiftKey;
+        });
+        editor.plugins.get(ClipboardPipeline).on('contentInsertion', (evt, data) => {
+            // Plain text can be determined based on the event flag (#7799) or auto-detection (#1006). If detected,
+            // preserve selection attributes on pasted items.
+            if (!shiftPressed && !isPlainTextFragment(data.content, model.schema)) {
+                return;
+            }
+            model.change(writer => {
+                // Formatting attributes should be preserved.
+                const textAttributes = Array.from(selection.getAttributes())
+                    .filter(([key]) => model.schema.getAttributeProperties(key).isFormatting);
+                if (!selection.isCollapsed) {
+                    model.deleteContent(selection, { doNotAutoparagraph: true });
+                }
+                // Also preserve other attributes if they survived the content deletion (because they were not fully selected).
+                // For example linkHref is not a formatting attribute but it should be preserved if pasted text was in the middle
+                // of a link.
+                textAttributes.push(...selection.getAttributes());
+                const range = writer.createRangeIn(data.content);
+                for (const item of range.getItems()) {
+                    if (item.is('$textProxy')) {
+                        writer.setAttributes(textAttributes, item);
+                    }
+                }
+            });
+        });
+    }
 }
-
 // Returns true if specified `documentFragment` represents a plain text.
 //
 // @param {module:engine/view/documentfragment~DocumentFragment} documentFragment
 // @param {module:engine/model/schema~Schema} schema
 // @returns {Boolean}
-function isPlainTextFragment( documentFragment, schema ) {
-	if ( documentFragment.childCount > 1 ) {
-		return false;
-	}
-
-	const child = documentFragment.getChild( 0 );
-
-	if ( schema.isObject( child ) ) {
-		return false;
-	}
-
-	return [ ...child.getAttributeKeys() ].length == 0;
+function isPlainTextFragment(documentFragment, schema) {
+    if (documentFragment.childCount > 1) {
+        return false;
+    }
+    const child = documentFragment.getChild(0);
+    if (schema.isObject(child)) {
+        return false;
+    }
+    return Array.from(child.getAttributeKeys()).length == 0;
 }

package/src/utils/normalizeclipboarddata.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module clipboard/utils/normalizeclipboarddata
  */
-
 /**
  * Removes some popular browser quirks out of the clipboard data (HTML).
  * Removes all HTML comments. These are considered an internal thing and it makes little sense if they leak into the editor data.
@@ -14,17 +12,16 @@
  * @param {String} data The HTML data to normalize.
  * @returns {String} Normalized HTML.
  */
-export default function normalizeClipboardData( data ) {
-	return data
-		.replace( /<span(?: class="Apple-converted-space"|)>(\s+)<\/span>/g, ( fullMatch, spaces ) => {
-			// Handle the most popular and problematic case when even a single space becomes an nbsp;.
-			// Decode those to normal spaces. Read more in https://github.com/ckeditor/ckeditor5-clipboard/issues/2.
-			if ( spaces.length == 1 ) {
-				return ' ';
-			}
-
-			return spaces;
-		} )
-		// Remove all HTML comments.
-		.replace( /<!--[\s\S]*?-->/g, '' );
+export default function normalizeClipboardData(data) {
+    return data
+        .replace(/<span(?: class="Apple-converted-space"|)>(\s+)<\/span>/g, (fullMatch, spaces) => {
+        // Handle the most popular and problematic case when even a single space becomes an nbsp;.
+        // Decode those to normal spaces. Read more in https://github.com/ckeditor/ckeditor5-clipboard/issues/2.
+        if (spaces.length == 1) {
+            return ' ';
+        }
+        return spaces;
+    })
+        // Remove all HTML comments.
+        .replace(/<!--[\s\S]*?-->/g, '');
 }

package/src/utils/plaintexttohtml.js

@@ -2,39 +2,34 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module clipboard/utils/plaintexttohtml
  */
-
 /**
  * Converts plain text to its HTML-ized version.
  *
  * @param {String} text The plain text to convert.
  * @returns {String} HTML generated from the plain text.
  */
-export default function plainTextToHtml( text ) {
-	text = text
-		// Encode <>.
-		.replace( /</g, '&lt;' )
-		.replace( />/g, '&gt;' )
-		// Creates a paragraph for each double line break.
-		.replace( /\r?\n\r?\n/g, '</p><p>' )
-		// Creates a line break for each single line break.
-		.replace( /\r?\n/g, '<br>' )
-		// Preserve trailing spaces (only the first and last one – the rest is handled below).
-		.replace( /^\s/, '&nbsp;' )
-		.replace( /\s$/, '&nbsp;' )
-		// Preserve other subsequent spaces now.
-		.replace( /\s\s/g, ' &nbsp;' );
-
-	if ( text.includes( '</p><p>' ) || text.includes( '<br>' ) ) {
-		// If we created paragraphs above, add the trailing ones.
-		text = `<p>${ text }</p>`;
-	}
-
-	// TODO:
-	// * What about '\nfoo' vs ' foo'?
-
-	return text;
+export default function plainTextToHtml(text) {
+    text = text
+        // Encode <>.
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        // Creates a paragraph for each double line break.
+        .replace(/\r?\n\r?\n/g, '</p><p>')
+        // Creates a line break for each single line break.
+        .replace(/\r?\n/g, '<br>')
+        // Preserve trailing spaces (only the first and last one – the rest is handled below).
+        .replace(/^\s/, '&nbsp;')
+        .replace(/\s$/, '&nbsp;')
+        // Preserve other subsequent spaces now.
+        .replace(/\s\s/g, ' &nbsp;');
+    if (text.includes('</p><p>') || text.includes('<br>')) {
+        // If we created paragraphs above, add the trailing ones.
+        text = `<p>${text}</p>`;
+    }
+    // TODO:
+    // * What about '\nfoo' vs ' foo'?
+    return text;
 }

package/src/utils/viewtoplaintext.js

@@ -2,55 +2,49 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module clipboard/utils/viewtoplaintext
- */
-
 // Elements which should not have empty-line padding.
 // Most `view.ContainerElement` want to be separate by new-line, but some are creating one structure
 // together (like `<li>`) so it is better to separate them by only one "\n".
-const smallPaddingElements = [ 'figcaption', 'li' ];
-
+const smallPaddingElements = ['figcaption', 'li'];
 /**
  * Converts {@link module:engine/view/item~Item view item} and all of its children to plain text.
  *
  * @param {module:engine/view/item~Item} viewItem View item to convert.
  * @returns {String} Plain text representation of `viewItem`.
  */
-export default function viewToPlainText( viewItem ) {
-	let text = '';
-
-	if ( viewItem.is( '$text' ) || viewItem.is( '$textProxy' ) ) {
-		// If item is `Text` or `TextProxy` simple take its text data.
-		text = viewItem.data;
-	} else if ( viewItem.is( 'element', 'img' ) && viewItem.hasAttribute( 'alt' ) ) {
-		// Special case for images - use alt attribute if it is provided.
-		text = viewItem.getAttribute( 'alt' );
-	} else if ( viewItem.is( 'element', 'br' ) ) {
-		// A soft break should be converted into a single line break (#8045).
-		text = '\n';
-	} else {
-		// Other elements are document fragments, attribute elements or container elements.
-		// They don't have their own text value, so convert their children.
-		let prev = null;
-
-		for ( const child of viewItem.getChildren() ) {
-			const childText = viewToPlainText( child );
-
-			// Separate container element children with one or more new-line characters.
-			if ( prev && ( prev.is( 'containerElement' ) || child.is( 'containerElement' ) ) ) {
-				if ( smallPaddingElements.includes( prev.name ) || smallPaddingElements.includes( child.name ) ) {
-					text += '\n';
-				} else {
-					text += '\n\n';
-				}
-			}
-
-			text += childText;
-			prev = child;
-		}
-	}
-
-	return text;
+export default function viewToPlainText(viewItem) {
+    let text = '';
+    if (viewItem.is('$text') || viewItem.is('$textProxy')) {
+        // If item is `Text` or `TextProxy` simple take its text data.
+        text = viewItem.data;
+    }
+    else if (viewItem.is('element', 'img') && viewItem.hasAttribute('alt')) {
+        // Special case for images - use alt attribute if it is provided.
+        text = viewItem.getAttribute('alt');
+    }
+    else if (viewItem.is('element', 'br')) {
+        // A soft break should be converted into a single line break (#8045).
+        text = '\n';
+    }
+    else {
+        // Other elements are document fragments, attribute elements or container elements.
+        // They don't have their own text value, so convert their children.
+        let prev = null;
+        for (const child of viewItem.getChildren()) {
+            const childText = viewToPlainText(child);
+            // Separate container element children with one or more new-line characters.
+            if (prev && (prev.is('containerElement') || child.is('containerElement'))) {
+                if (smallPaddingElements.includes(prev.name) ||
+                    smallPaddingElements.includes(child.name)) {
+                    text += '\n';
+                }
+                else {
+                    text += '\n\n';
+                }
+            }
+            text += childText;
+            prev = child;
+        }
+    }
+    return text;
 }

package/src/datatransfer.js

@@ -1,112 +0,0 @@
-/**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-
-/**
- * @module clipboard/datatransfer
- */
-
-/**
- * A facade over the native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
- */
-export default class DataTransfer {
-	constructor( nativeDataTransfer ) {
-		/**
-		 * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-		 *
-		 * @readonly
-		 * @member {Array.<File>} #files
-		 */
-		this.files = getFiles( nativeDataTransfer );
-
-		/**
-		 * The native DataTransfer object.
-		 *
-		 * @private
-		 * @member {DataTransfer} #_native
-		 */
-		this._native = nativeDataTransfer;
-	}
-
-	/**
-	 * Returns an array of available native content types.
-	 *
-	 * @returns {Array.<String>}
-	 */
-	get types() {
-		return this._native.types;
-	}
-
-	/**
-	 * Gets the data from the data transfer by its MIME type.
-	 *
-	 *		dataTransfer.getData( 'text/plain' );
-	 *
-	 * @param {String} type The MIME type. E.g. `text/html` or `text/plain`.
-	 * @returns {String}
-	 */
-	getData( type ) {
-		return this._native.getData( type );
-	}
-
-	/**
-	 * Sets the data in the data transfer.
-	 *
-	 * @param {String} type The MIME type. E.g. `text/html` or `text/plain`.
-	 * @param {String} data
-	 */
-	setData( type, data ) {
-		this._native.setData( type, data );
-	}
-
-	/**
-	 * The effect that is allowed for a drag operation.
-	 *
-	 * @param {String} value
-	 */
-	set effectAllowed( value ) {
-		this._native.effectAllowed = value;
-	}
-
-	get effectAllowed() {
-		return this._native.effectAllowed;
-	}
-
-	/**
-	 * The actual drop effect.
-	 *
-	 * @param {String} value
-	 */
-	set dropEffect( value ) {
-		this._native.dropEffect = value;
-	}
-
-	get dropEffect() {
-		return this._native.dropEffect;
-	}
-
-	/**
-	 * Whether the dragging operation was canceled.
-	 *
-	 * @returns {Boolean}
-	 */
-	get isCanceled() {
-		return this._native.dropEffect == 'none' || !!this._native.mozUserCancelled;
-	}
-}
-
-function getFiles( nativeDataTransfer ) {
-	// DataTransfer.files and items are array-like and might not have an iterable interface.
-	const files = Array.from( nativeDataTransfer.files || [] );
-	const items = Array.from( nativeDataTransfer.items || [] );
-
-	if ( files.length ) {
-		return files;
-	}
-
-	// Chrome has empty DataTransfer.files, but allows getting files through the items interface.
-	return items
-		.filter( item => item.kind === 'file' )
-		.map( item => item.getAsFile() );
-}