@ckeditor/ckeditor5-html-support 36.0.1 → 37.0.0-alpha.1

package/src/integrations/documentlist.js

@@ -2,206 +2,169 @@
  * @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 html-support/integrations/documentlist
  */
-
 import { isEqual } from 'lodash-es';
 import { Plugin } from 'ckeditor5/src/core';
-import { setViewAttributes } from '../conversionutils.js';
-
+import { setViewAttributes } from '../conversionutils';
 import DataFilter from '../datafilter';
-
 /**
  * Provides the General HTML Support integration with the {@link module:list/documentlist~DocumentList Document List} feature.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class DocumentListElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'DocumentListElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		if ( !editor.plugins.has( 'DocumentListEditing' ) ) {
-			return;
-		}
-
-		const schema = editor.model.schema;
-		const conversion = editor.conversion;
-		const dataFilter = editor.plugins.get( DataFilter );
-		const documentListEditing = editor.plugins.get( 'DocumentListEditing' );
-
-		// Register downcast strategy.
-		// Note that this must be done before document list editing registers conversion in afterInit.
-		documentListEditing.registerDowncastStrategy( {
-			scope: 'item',
-			attributeName: 'htmlLiAttributes',
-
-			setAttributeOnDowncast( writer, attributeValue, viewElement ) {
-				setViewAttributes( writer, attributeValue, viewElement );
-			}
-		} );
-
-		documentListEditing.registerDowncastStrategy( {
-			scope: 'list',
-			attributeName: 'htmlListAttributes',
-
-			setAttributeOnDowncast( writer, viewAttributes, viewElement ) {
-				setViewAttributes( writer, viewAttributes, viewElement );
-			}
-		} );
-
-		dataFilter.on( 'register', ( evt, definition ) => {
-			if ( ![ 'ul', 'ol', 'li' ].includes( definition.view ) ) {
-				return;
-			}
-
-			evt.stop();
-
-			// Do not register same converters twice.
-			if ( schema.checkAttribute( '$block', 'htmlListAttributes' ) ) {
-				return;
-			}
-
-			schema.extend( '$block', { allowAttributes: [ 'htmlListAttributes', 'htmlLiAttributes' ] } );
-			schema.extend( '$blockObject', { allowAttributes: [ 'htmlListAttributes', 'htmlLiAttributes' ] } );
-			schema.extend( '$container', { allowAttributes: [ 'htmlListAttributes', 'htmlLiAttributes' ] } );
-
-			conversion.for( 'upcast' ).add( dispatcher => {
-				dispatcher.on( 'element:ul', viewToModelListAttributeConverter( 'htmlListAttributes', dataFilter ), { priority: 'low' } );
-				dispatcher.on( 'element:ol', viewToModelListAttributeConverter( 'htmlListAttributes', dataFilter ), { priority: 'low' } );
-				dispatcher.on( 'element:li', viewToModelListAttributeConverter( 'htmlLiAttributes', dataFilter ), { priority: 'low' } );
-			} );
-		} );
-
-		// Make sure that all items in a single list (items at the same level & listType) have the same properties.
-		// Note: This is almost an exact copy from DocumentListPropertiesEditing.
-		documentListEditing.on( 'postFixer', ( evt, { listNodes, writer } ) => {
-			const previousNodesByIndent = []; // Last seen nodes of lower indented lists.
-
-			for ( const { node, previous } of listNodes ) {
-				// For the first list block there is nothing to compare with.
-				if ( !previous ) {
-					continue;
-				}
-
-				const nodeIndent = node.getAttribute( 'listIndent' );
-				const previousNodeIndent = previous.getAttribute( 'listIndent' );
-
-				let previousNodeInList = null; // It's like `previous` but has the same indent as current node.
-
-				// Let's find previous node for the same indent.
-				// We're going to need that when we get back to previous indent.
-				if ( nodeIndent > previousNodeIndent ) {
-					previousNodesByIndent[ previousNodeIndent ] = previous;
-				}
-				// Restore the one for given indent.
-				else if ( nodeIndent < previousNodeIndent ) {
-					previousNodeInList = previousNodesByIndent[ nodeIndent ];
-					previousNodesByIndent.length = nodeIndent;
-				}
-				// Same indent.
-				else {
-					previousNodeInList = previous;
-				}
-
-				// This is a first item of a nested list.
-				if ( !previousNodeInList ) {
-					continue;
-				}
-
-				if ( previousNodeInList.getAttribute( 'listType' ) == node.getAttribute( 'listType' ) ) {
-					const value = previousNodeInList.getAttribute( 'htmlListAttributes' );
-
-					if ( !isEqual( node.getAttribute( 'htmlListAttributes' ), value ) ) {
-						writer.setAttribute( 'htmlListAttributes', value, node );
-						evt.return = true;
-					}
-				}
-
-				if ( previousNodeInList.getAttribute( 'listItemId' ) == node.getAttribute( 'listItemId' ) ) {
-					const value = previousNodeInList.getAttribute( 'htmlLiAttributes' );
-
-					if ( !isEqual( node.getAttribute( 'htmlLiAttributes' ), value ) ) {
-						writer.setAttribute( 'htmlLiAttributes', value, node );
-						evt.return = true;
-					}
-				}
-			}
-		} );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	afterInit() {
-		const editor = this.editor;
-
-		if ( !editor.commands.get( 'indentList' ) ) {
-			return;
-		}
-
-		// Reset list attributes after indenting list items.
-		this.listenTo( editor.commands.get( 'indentList' ), 'afterExecute', ( evt, changedBlocks ) => {
-			editor.model.change( writer => {
-				for ( const node of changedBlocks ) {
-					// Just reset the attribute.
-					// If there is a previous indented list that this node should be merged into,
-					// the postfixer will unify all the attributes of both sub-lists.
-					writer.setAttribute( 'htmlListAttributes', {}, node );
-				}
-			} );
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DocumentListElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        if (!editor.plugins.has('DocumentListEditing')) {
+            return;
+        }
+        const schema = editor.model.schema;
+        const conversion = editor.conversion;
+        const dataFilter = editor.plugins.get(DataFilter);
+        const documentListEditing = editor.plugins.get('DocumentListEditing');
+        // Register downcast strategy.
+        // Note that this must be done before document list editing registers conversion in afterInit.
+        documentListEditing.registerDowncastStrategy({
+            scope: 'item',
+            attributeName: 'htmlLiAttributes',
+            setAttributeOnDowncast(writer, attributeValue, viewElement) {
+                setViewAttributes(writer, attributeValue, viewElement);
+            }
+        });
+        documentListEditing.registerDowncastStrategy({
+            scope: 'list',
+            attributeName: 'htmlListAttributes',
+            setAttributeOnDowncast(writer, viewAttributes, viewElement) {
+                setViewAttributes(writer, viewAttributes, viewElement);
+            }
+        });
+        dataFilter.on('register', (evt, definition) => {
+            if (!['ul', 'ol', 'li'].includes(definition.view)) {
+                return;
+            }
+            evt.stop();
+            // Do not register same converters twice.
+            if (schema.checkAttribute('$block', 'htmlListAttributes')) {
+                return;
+            }
+            schema.extend('$block', { allowAttributes: ['htmlListAttributes', 'htmlLiAttributes'] });
+            schema.extend('$blockObject', { allowAttributes: ['htmlListAttributes', 'htmlLiAttributes'] });
+            schema.extend('$container', { allowAttributes: ['htmlListAttributes', 'htmlLiAttributes'] });
+            conversion.for('upcast').add(dispatcher => {
+                dispatcher.on('element:ul', viewToModelListAttributeConverter('htmlListAttributes', dataFilter), { priority: 'low' });
+                dispatcher.on('element:ol', viewToModelListAttributeConverter('htmlListAttributes', dataFilter), { priority: 'low' });
+                dispatcher.on('element:li', viewToModelListAttributeConverter('htmlLiAttributes', dataFilter), { priority: 'low' });
+            });
+        });
+        // Make sure that all items in a single list (items at the same level & listType) have the same properties.
+        // Note: This is almost an exact copy from DocumentListPropertiesEditing.
+        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
+            const previousNodesByIndent = []; // Last seen nodes of lower indented lists.
+            for (const { node, previous } of listNodes) {
+                // For the first list block there is nothing to compare with.
+                if (!previous) {
+                    continue;
+                }
+                const nodeIndent = node.getAttribute('listIndent');
+                const previousNodeIndent = previous.getAttribute('listIndent');
+                let previousNodeInList = null; // It's like `previous` but has the same indent as current node.
+                // Let's find previous node for the same indent.
+                // We're going to need that when we get back to previous indent.
+                if (nodeIndent > previousNodeIndent) {
+                    previousNodesByIndent[previousNodeIndent] = previous;
+                }
+                // Restore the one for given indent.
+                else if (nodeIndent < previousNodeIndent) {
+                    previousNodeInList = previousNodesByIndent[nodeIndent];
+                    previousNodesByIndent.length = nodeIndent;
+                }
+                // Same indent.
+                else {
+                    previousNodeInList = previous;
+                }
+                // This is a first item of a nested list.
+                if (!previousNodeInList) {
+                    continue;
+                }
+                if (previousNodeInList.getAttribute('listType') == node.getAttribute('listType')) {
+                    const value = previousNodeInList.getAttribute('htmlListAttributes');
+                    if (!isEqual(node.getAttribute('htmlListAttributes'), value)) {
+                        writer.setAttribute('htmlListAttributes', value, node);
+                        evt.return = true;
+                    }
+                }
+                if (previousNodeInList.getAttribute('listItemId') == node.getAttribute('listItemId')) {
+                    const value = previousNodeInList.getAttribute('htmlLiAttributes');
+                    if (!isEqual(node.getAttribute('htmlLiAttributes'), value)) {
+                        writer.setAttribute('htmlLiAttributes', value, node);
+                        evt.return = true;
+                    }
+                }
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const editor = this.editor;
+        if (!editor.commands.get('indentList')) {
+            return;
+        }
+        // Reset list attributes after indenting list items.
+        const indentList = editor.commands.get('indentList');
+        this.listenTo(indentList, 'afterExecute', (evt, changedBlocks) => {
+            editor.model.change(writer => {
+                for (const node of changedBlocks) {
+                    // Just reset the attribute.
+                    // If there is a previous indented list that this node should be merged into,
+                    // the postfixer will unify all the attributes of both sub-lists.
+                    writer.setAttribute('htmlListAttributes', {}, node);
+                }
+            });
+        });
+    }
 }
-
-// View-to-model conversion helper preserving allowed attributes on {@link TODO}
-// feature model element.
-//
-// @private
-// @param {String} attributeName
-// @param {module:html-support/datafilter~DataFilter} dataFilter
-// @returns {Function} Returns a conversion callback.
-function viewToModelListAttributeConverter( attributeName, dataFilter ) {
-	return ( evt, data, conversionApi ) => {
-		const viewElement = data.viewItem;
-
-		if ( !data.modelRange ) {
-			Object.assign( data, conversionApi.convertChildren( data.viewItem, data.modelCursor ) );
-		}
-
-		const viewAttributes = dataFilter.processViewAttributes( viewElement, conversionApi );
-
-		for ( const item of data.modelRange.getItems( { shallow: true } ) ) {
-			// Apply only to list item blocks.
-			if ( !item.hasAttribute( 'listItemId' ) ) {
-				continue;
-			}
-
-			// Set list attributes only on same level items, those nested deeper are already handled
-			// by the recursive conversion.
-			if ( item.hasAttribute( attributeName ) ) {
-				continue;
-			}
-
-			conversionApi.writer.setAttribute( attributeName, viewAttributes || {}, item );
-		}
-	};
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link TODO}
+ * feature model element.
+ *
+ * @returns Returns a conversion callback.
+ */
+function viewToModelListAttributeConverter(attributeName, dataFilter) {
+    const callback = (evt, data, conversionApi) => {
+        const viewElement = data.viewItem;
+        if (!data.modelRange) {
+            Object.assign(data, conversionApi.convertChildren(data.viewItem, data.modelCursor));
+        }
+        const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
+        for (const item of data.modelRange.getItems({ shallow: true })) {
+            // Apply only to list item blocks.
+            if (!item.hasAttribute('listItemId')) {
+                continue;
+            }
+            // Set list attributes only on same level items, those nested deeper are already handled
+            // by the recursive conversion.
+            if (item.hasAttribute(attributeName)) {
+                continue;
+            }
+            conversionApi.writer.setAttribute(attributeName, viewAttributes || {}, item);
+        }
+    };
+    return callback;
 }

package/src/integrations/dualcontent.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @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 { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * Provides the General HTML Support integration for elements which can behave like sectioning element (e.g. article) or
+ * element accepting only inline content (e.g. paragraph).
+ *
+ * The distinction between this two content models is important for choosing correct schema model and proper content conversion.
+ * As an example, it ensures that:
+ *
+ * * children elements paragraphing is enabled for sectioning elements only,
+ * * element and its content can be correctly handled by editing view (splitting and merging elements),
+ * * model element HTML is semantically correct and easier to work with.
+ *
+ * If element contains any block element, it will be treated as a sectioning element and registered using
+ * {@link module:html-support/dataschema~DataSchemaDefinition#model} and
+ * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
+ * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
+ * name with model schema accepting only inline content (inheriting from `$block`).
+ */
+export default class DualContentModelElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'DualContentModelElementSupport';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Checks whether the given view element includes any other block element.
+     */
+    private _hasBlockContent;
+    /**
+     * Adds attribute filtering conversion for the given data schema.
+     */
+    private _addAttributeConversion;
+}

package/src/integrations/dualcontent.js

@@ -2,20 +2,10 @@
  * @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 html-support/integrations/dualcontent
- */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { priorities } from 'ckeditor5/src/utils';
-import {
-	modelToViewBlockAttributeConverter,
-	viewToModelBlockAttributeConverter
-} from '../converters';
-
+import { modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter } from '../converters';
 import DataFilter from '../datafilter';
-
 /**
  * Provides the General HTML Support integration for elements which can behave like sectioning element (e.g. article) or
  * element accepting only inline content (e.g. paragraph).
@@ -32,123 +22,97 @@ import DataFilter from '../datafilter';
  * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
  * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
  * name with model schema accepting only inline content (inheriting from `$block`).
- *
- * @extends module:core/plugin~Plugin
  */
 export default class DualContentModelElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'DualContentModelElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const dataFilter = this.editor.plugins.get( DataFilter );
-
-		dataFilter.on( 'register', ( evt, definition ) => {
-			const editor = this.editor;
-			const schema = editor.model.schema;
-			const conversion = editor.conversion;
-
-			if ( !definition.paragraphLikeModel ) {
-				return;
-			}
-
-			// Can only apply to newly registered features.
-			if ( schema.isRegistered( definition.model ) || schema.isRegistered( definition.paragraphLikeModel ) ) {
-				return;
-			}
-
-			const paragraphLikeModelDefinition = {
-				model: definition.paragraphLikeModel,
-				view: definition.view
-			};
-
-			schema.register( definition.model, definition.modelSchema );
-			schema.register( paragraphLikeModelDefinition.model, {
-				inheritAllFrom: '$block'
-			} );
-
-			conversion.for( 'upcast' ).elementToElement( {
-				view: definition.view,
-				model: ( viewElement, { writer } ) => {
-					if ( this._hasBlockContent( viewElement ) ) {
-						return writer.createElement( definition.model );
-					}
-
-					return writer.createElement( paragraphLikeModelDefinition.model );
-				},
-				// With a `low` priority, `paragraph` plugin auto-paragraphing mechanism is executed. Make sure
-				// this listener is called before it. If not, some elements will be transformed into a paragraph.
-				converterPriority: priorities.get( 'low' ) + 1
-			} );
-
-			conversion.for( 'downcast' ).elementToElement( {
-				view: definition.view,
-				model: definition.model
-			} );
-			this._addAttributeConversion( definition );
-
-			conversion.for( 'downcast' ).elementToElement( {
-				view: paragraphLikeModelDefinition.view,
-				model: paragraphLikeModelDefinition.model
-			} );
-			this._addAttributeConversion( paragraphLikeModelDefinition );
-
-			evt.stop();
-		} );
-	}
-
-	/**
-	 * Checks whether the given view element includes any other block element.
-	 *
-	 * @private
-	 * @param {module:engine/view/element~Element} viewElement
-	 * @returns {Boolean}
-	 */
-	_hasBlockContent( viewElement ) {
-		const view = this.editor.editing.view;
-		const blockElements = view.domConverter.blockElements;
-
-		// Traversing the viewElement subtree looking for block elements.
-		// Especially for the cases like <div><a href="#"><p>foo</p></a></div>.
-		// https://github.com/ckeditor/ckeditor5/issues/11513
-		for ( const viewItem of view.createRangeIn( viewElement ).getItems() ) {
-			if ( viewItem.is( 'element' ) && blockElements.includes( viewItem.name ) ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Adds attribute filtering conversion for the given data schema.
-	 *
-	 * @private
-	 * @param {module:html-support/dataschema~DataSchemaBlockElementDefinition} definition
-	 */
-	_addAttributeConversion( definition ) {
-		const editor = this.editor;
-		const conversion = editor.conversion;
-		const dataFilter = editor.plugins.get( DataFilter );
-
-		editor.model.schema.extend( definition.model, {
-			allowAttributes: 'htmlAttributes'
-		} );
-
-		conversion.for( 'upcast' ).add( viewToModelBlockAttributeConverter( definition, dataFilter ) );
-		conversion.for( 'downcast' ).add( modelToViewBlockAttributeConverter( definition ) );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'DualContentModelElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        dataFilter.on('register', (evt, definition) => {
+            const blockDefinition = definition;
+            const editor = this.editor;
+            const schema = editor.model.schema;
+            const conversion = editor.conversion;
+            if (!blockDefinition.paragraphLikeModel) {
+                return;
+            }
+            // Can only apply to newly registered features.
+            if (schema.isRegistered(blockDefinition.model) || schema.isRegistered(blockDefinition.paragraphLikeModel)) {
+                return;
+            }
+            const paragraphLikeModelDefinition = {
+                model: blockDefinition.paragraphLikeModel,
+                view: blockDefinition.view
+            };
+            schema.register(blockDefinition.model, blockDefinition.modelSchema);
+            schema.register(paragraphLikeModelDefinition.model, {
+                inheritAllFrom: '$block'
+            });
+            conversion.for('upcast').elementToElement({
+                view: blockDefinition.view,
+                model: (viewElement, { writer }) => {
+                    if (this._hasBlockContent(viewElement)) {
+                        return writer.createElement(blockDefinition.model);
+                    }
+                    return writer.createElement(paragraphLikeModelDefinition.model);
+                },
+                // With a `low` priority, `paragraph` plugin auto-paragraphing mechanism is executed. Make sure
+                // this listener is called before it. If not, some elements will be transformed into a paragraph.
+                converterPriority: priorities.get('low') + 0.5
+            });
+            conversion.for('downcast').elementToElement({
+                view: blockDefinition.view,
+                model: blockDefinition.model
+            });
+            this._addAttributeConversion(blockDefinition);
+            conversion.for('downcast').elementToElement({
+                view: paragraphLikeModelDefinition.view,
+                model: paragraphLikeModelDefinition.model
+            });
+            this._addAttributeConversion(paragraphLikeModelDefinition);
+            evt.stop();
+        });
+    }
+    /**
+     * Checks whether the given view element includes any other block element.
+     */
+    _hasBlockContent(viewElement) {
+        const view = this.editor.editing.view;
+        const blockElements = view.domConverter.blockElements;
+        // Traversing the viewElement subtree looking for block elements.
+        // Especially for the cases like <div><a href="#"><p>foo</p></a></div>.
+        // https://github.com/ckeditor/ckeditor5/issues/11513
+        for (const viewItem of view.createRangeIn(viewElement).getItems()) {
+            if (viewItem.is('element') && blockElements.includes(viewItem.name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Adds attribute filtering conversion for the given data schema.
+     */
+    _addAttributeConversion(definition) {
+        const editor = this.editor;
+        const conversion = editor.conversion;
+        const dataFilter = editor.plugins.get(DataFilter);
+        editor.model.schema.extend(definition.model, {
+            allowAttributes: 'htmlAttributes'
+        });
+        conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
+        conversion.for('downcast').add(modelToViewBlockAttributeConverter(definition));
+    }
 }