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

package/src/integrations/mediaembed.js

@@ -2,164 +2,118 @@
  * @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/mediaembed
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import DataFilter from '../datafilter';
 import DataSchema from '../dataschema';
-import { updateViewAttributes } from '../conversionutils.js';
-
+import { updateViewAttributes } from '../conversionutils';
+import { getDescendantElement } from './integrationutils';
 /**
  * Provides the General HTML Support integration with {@link module:media-embed/mediaembed~MediaEmbed Media Embed} feature.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class MediaEmbedElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'MediaEmbedElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		// Stop here if MediaEmbed plugin is not provided or the integrator wants to output markup with previews as
-		// we do not support filtering previews.
-		if ( !editor.plugins.has( 'MediaEmbed' ) || editor.config.get( 'mediaEmbed.previewsInData' ) ) {
-			return;
-		}
-
-		const schema = editor.model.schema;
-		const conversion = editor.conversion;
-		const dataFilter = this.editor.plugins.get( DataFilter );
-		const dataSchema = this.editor.plugins.get( DataSchema );
-		const mediaElementName = editor.config.get( 'mediaEmbed.elementName' );
-
-		// Overwrite GHS schema definition for a given elementName.
-		dataSchema.registerBlockElement( {
-			model: 'media',
-			view: mediaElementName
-		} );
-
-		dataFilter.on( 'register:figure', ( ) => {
-			conversion.for( 'upcast' ).add( viewToModelFigureAttributesConverter( dataFilter ) );
-		} );
-
-		dataFilter.on( `register:${ mediaElementName }`, ( evt, definition ) => {
-			if ( definition.model !== 'media' ) {
-				return;
-			}
-
-			schema.extend( 'media', {
-				allowAttributes: [
-					'htmlAttributes',
-					'htmlFigureAttributes'
-				]
-			} );
-
-			conversion.for( 'upcast' ).add( viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) );
-			conversion.for( 'dataDowncast' ).add( modelToViewMediaAttributeConverter( mediaElementName ) );
-
-			evt.stop();
-		} );
-	}
-}
-
-function viewToModelMediaAttributesConverter( dataFilter, mediaElementName ) {
-	return dispatcher => {
-		dispatcher.on( `element:${ mediaElementName }`, upcastMedia, { priority: 'low' } );
-	};
-
-	function upcastMedia( evt, data, conversionApi ) {
-		const viewMediaElement = data.viewItem;
-
-		preserveElementAttributes( viewMediaElement, 'htmlAttributes' );
-
-		function preserveElementAttributes( viewElement, attributeName ) {
-			const viewAttributes = dataFilter.processViewAttributes( viewElement, conversionApi );
-
-			if ( viewAttributes ) {
-				conversionApi.writer.setAttribute( attributeName, viewAttributes, data.modelRange );
-			}
-		}
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'MediaEmbedElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Stop here if MediaEmbed plugin is not provided or the integrator wants to output markup with previews as
+        // we do not support filtering previews.
+        if (!editor.plugins.has('MediaEmbed') || editor.config.get('mediaEmbed.previewsInData')) {
+            return;
+        }
+        const schema = editor.model.schema;
+        const conversion = editor.conversion;
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        const dataSchema = this.editor.plugins.get(DataSchema);
+        const mediaElementName = editor.config.get('mediaEmbed.elementName');
+        // Overwrite GHS schema definition for a given elementName.
+        dataSchema.registerBlockElement({
+            model: 'media',
+            view: mediaElementName
+        });
+        dataFilter.on('register:figure', () => {
+            conversion.for('upcast').add(viewToModelFigureAttributesConverter(dataFilter));
+        });
+        dataFilter.on(`register:${mediaElementName}`, (evt, definition) => {
+            if (definition.model !== 'media') {
+                return;
+            }
+            schema.extend('media', {
+                allowAttributes: [
+                    'htmlAttributes',
+                    'htmlFigureAttributes'
+                ]
+            });
+            conversion.for('upcast').add(viewToModelMediaAttributesConverter(dataFilter, mediaElementName));
+            conversion.for('dataDowncast').add(modelToViewMediaAttributeConverter(mediaElementName));
+            evt.stop();
+        });
+    }
 }
-
-// View-to-model conversion helper preserving allowed attributes on {@link module:media-embed/mediaembed~MediaEmbed MediaEmbed}
-// feature model element from figure view element.
-//
-// @private
-// @param {module:html-support/datafilter~DataFilter} dataFilter
-// @returns {Function} Returns a conversion callback.
-function viewToModelFigureAttributesConverter( dataFilter ) {
-	return dispatcher => {
-		dispatcher.on( 'element:figure', ( evt, data, conversionApi ) => {
-			const viewFigureElement = data.viewItem;
-
-			if ( !data.modelRange || !viewFigureElement.hasClass( 'media' ) ) {
-				return;
-			}
-
-			const viewAttributes = dataFilter.processViewAttributes( viewFigureElement, conversionApi );
-
-			if ( viewAttributes ) {
-				conversionApi.writer.setAttribute( 'htmlFigureAttributes', viewAttributes, data.modelRange );
-			}
-		}, { priority: 'low' } );
-	};
+function viewToModelMediaAttributesConverter(dataFilter, mediaElementName) {
+    const upcastMedia = (evt, data, conversionApi) => {
+        const viewMediaElement = data.viewItem;
+        preserveElementAttributes(viewMediaElement, 'htmlAttributes');
+        function preserveElementAttributes(viewElement, attributeName) {
+            const viewAttributes = dataFilter.processViewAttributes(viewElement, conversionApi);
+            if (viewAttributes) {
+                conversionApi.writer.setAttribute(attributeName, viewAttributes, data.modelRange);
+            }
+        }
+    };
+    return (dispatcher) => {
+        dispatcher.on(`element:${mediaElementName}`, upcastMedia, { priority: 'low' });
+    };
 }
-
-function modelToViewMediaAttributeConverter( mediaElementName ) {
-	return dispatcher => {
-		addAttributeConversionDispatcherHandler( mediaElementName, 'htmlAttributes' );
-		addAttributeConversionDispatcherHandler( 'figure', 'htmlFigureAttributes' );
-
-		function addAttributeConversionDispatcherHandler( elementName, attributeName ) {
-			dispatcher.on( `attribute:${ attributeName }:media`, ( evt, data, conversionApi ) => {
-				if ( !conversionApi.consumable.consume( data.item, evt.name ) ) {
-					return;
-				}
-
-				const { attributeOldValue, attributeNewValue } = data;
-				const containerElement = conversionApi.mapper.toViewElement( data.item );
-				const viewElement = getDescendantElement( conversionApi.writer, containerElement, elementName );
-
-				updateViewAttributes( conversionApi.writer, attributeOldValue, attributeNewValue, viewElement );
-			} );
-		}
-	};
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link module:media-embed/mediaembed~MediaEmbed MediaEmbed}
+ * feature model element from figure view element.
+ *
+ * @returns Returns a conversion callback.
+ */
+function viewToModelFigureAttributesConverter(dataFilter) {
+    return (dispatcher) => {
+        dispatcher.on('element:figure', (evt, data, conversionApi) => {
+            const viewFigureElement = data.viewItem;
+            if (!data.modelRange || !viewFigureElement.hasClass('media')) {
+                return;
+            }
+            const viewAttributes = dataFilter.processViewAttributes(viewFigureElement, conversionApi);
+            if (viewAttributes) {
+                conversionApi.writer.setAttribute('htmlFigureAttributes', viewAttributes, data.modelRange);
+            }
+        }, { priority: 'low' });
+    };
 }
-
-// Returns the first view element descendant matching the given view name.
-// Includes view element itself.
-//
-// @private
-// @param {module:engine/view/downcastwriter~DowncastWriter} writer
-// @param {module:engine/view/element~Element} containerElement
-// @param {String} elementName
-// @returns {module:engine/view/element~Element|null}
-function getDescendantElement( writer, containerElement, elementName ) {
-	const range = writer.createRangeOn( containerElement );
-
-	for ( const { item } of range.getWalker() ) {
-		if ( item.is( 'element', elementName ) ) {
-			return item;
-		}
-	}
+function modelToViewMediaAttributeConverter(mediaElementName) {
+    return (dispatcher) => {
+        addAttributeConversionDispatcherHandler(mediaElementName, 'htmlAttributes');
+        addAttributeConversionDispatcherHandler('figure', 'htmlFigureAttributes');
+        function addAttributeConversionDispatcherHandler(elementName, attributeName) {
+            dispatcher.on(`attribute:${attributeName}:media`, (evt, data, conversionApi) => {
+                if (!conversionApi.consumable.consume(data.item, evt.name)) {
+                    return;
+                }
+                const { attributeOldValue, attributeNewValue } = data;
+                const containerElement = conversionApi.mapper.toViewElement(data.item);
+                const viewElement = getDescendantElement(conversionApi.writer, containerElement, elementName);
+                updateViewAttributes(conversionApi.writer, attributeOldValue, attributeNewValue, viewElement);
+            });
+        }
+    };
 }

package/src/integrations/script.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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/script
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * Provides the General HTML Support for `script` elements.
+ */
+export default class ScriptElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'ScriptElementSupport';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/integrations/script.js

@@ -2,80 +2,58 @@
  * @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/script
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-import {
-	createObjectView,
-	modelToViewBlockAttributeConverter,
-	viewToModelBlockAttributeConverter,
-	viewToModelObjectConverter
-} from '../converters.js';
-
+import { createObjectView, modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter, viewToModelObjectConverter } from '../converters';
 import DataFilter from '../datafilter';
-
 /**
  * Provides the General HTML Support for `script` elements.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class ScriptElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'ScriptElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const dataFilter = this.editor.plugins.get( DataFilter );
-
-		dataFilter.on( 'register:script', ( evt, definition ) => {
-			const editor = this.editor;
-			const schema = editor.model.schema;
-			const conversion = editor.conversion;
-
-			schema.register( 'htmlScript', definition.modelSchema );
-
-			schema.extend( 'htmlScript', {
-				allowAttributes: [ 'htmlAttributes', 'htmlContent' ],
-				isContent: true
-			} );
-
-			editor.data.registerRawContentMatcher( {
-				name: 'script'
-			} );
-
-			conversion.for( 'upcast' ).elementToElement( {
-				view: 'script',
-				model: viewToModelObjectConverter( definition )
-			} );
-
-			conversion.for( 'upcast' ).add( viewToModelBlockAttributeConverter( definition, dataFilter ) );
-
-			conversion.for( 'downcast' ).elementToElement( {
-				model: 'htmlScript',
-				view: ( modelElement, { writer } ) => {
-					return createObjectView( 'script', modelElement, writer );
-				}
-			} );
-
-			conversion.for( 'downcast' ).add( modelToViewBlockAttributeConverter( definition ) );
-
-			evt.stop();
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ScriptElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        dataFilter.on('register:script', (evt, definition) => {
+            const editor = this.editor;
+            const schema = editor.model.schema;
+            const conversion = editor.conversion;
+            schema.register('htmlScript', definition.modelSchema);
+            schema.extend('htmlScript', {
+                allowAttributes: ['htmlAttributes', 'htmlContent'],
+                isContent: true
+            });
+            editor.data.registerRawContentMatcher({
+                name: 'script'
+            });
+            conversion.for('upcast').elementToElement({
+                view: 'script',
+                model: viewToModelObjectConverter(definition)
+            });
+            conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
+            conversion.for('downcast').elementToElement({
+                model: 'htmlScript',
+                view: (modelElement, { writer }) => {
+                    return createObjectView('script', modelElement, writer);
+                }
+            });
+            conversion.for('downcast').add(modelToViewBlockAttributeConverter(definition));
+            evt.stop();
+        });
+    }
 }

package/src/integrations/style.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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/style
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * Provides the General HTML Support for `style` elements.
+ */
+export default class StyleElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'StyleElementSupport';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/integrations/style.js

@@ -2,80 +2,58 @@
  * @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/style
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-import {
-	createObjectView,
-	modelToViewBlockAttributeConverter,
-	viewToModelBlockAttributeConverter,
-	viewToModelObjectConverter
-} from '../converters.js';
-
+import { createObjectView, modelToViewBlockAttributeConverter, viewToModelBlockAttributeConverter, viewToModelObjectConverter } from '../converters';
 import DataFilter from '../datafilter';
-
 /**
  * Provides the General HTML Support for `style` elements.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class StyleElementSupport extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ DataFilter ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'StyleElementSupport';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const dataFilter = this.editor.plugins.get( DataFilter );
-
-		dataFilter.on( 'register:style', ( evt, definition ) => {
-			const editor = this.editor;
-			const schema = editor.model.schema;
-			const conversion = editor.conversion;
-
-			schema.register( 'htmlStyle', definition.modelSchema );
-
-			schema.extend( 'htmlStyle', {
-				allowAttributes: [ 'htmlAttributes', 'htmlContent' ],
-				isContent: true
-			} );
-
-			editor.data.registerRawContentMatcher( {
-				name: 'style'
-			} );
-
-			conversion.for( 'upcast' ).elementToElement( {
-				view: 'style',
-				model: viewToModelObjectConverter( definition )
-			} );
-
-			conversion.for( 'upcast' ).add( viewToModelBlockAttributeConverter( definition, dataFilter ) );
-
-			conversion.for( 'downcast' ).elementToElement( {
-				model: 'htmlStyle',
-				view: ( modelElement, { writer } ) => {
-					return createObjectView( 'style', modelElement, writer );
-				}
-			} );
-
-			conversion.for( 'downcast' ).add( modelToViewBlockAttributeConverter( definition ) );
-
-			evt.stop();
-		} );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [DataFilter];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'StyleElementSupport';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const dataFilter = this.editor.plugins.get(DataFilter);
+        dataFilter.on('register:style', (evt, definition) => {
+            const editor = this.editor;
+            const schema = editor.model.schema;
+            const conversion = editor.conversion;
+            schema.register('htmlStyle', definition.modelSchema);
+            schema.extend('htmlStyle', {
+                allowAttributes: ['htmlAttributes', 'htmlContent'],
+                isContent: true
+            });
+            editor.data.registerRawContentMatcher({
+                name: 'style'
+            });
+            conversion.for('upcast').elementToElement({
+                view: 'style',
+                model: viewToModelObjectConverter(definition)
+            });
+            conversion.for('upcast').add(viewToModelBlockAttributeConverter(definition, dataFilter));
+            conversion.for('downcast').elementToElement({
+                model: 'htmlStyle',
+                view: (modelElement, { writer }) => {
+                    return createObjectView('style', modelElement, writer);
+                }
+            });
+            conversion.for('downcast').add(modelToViewBlockAttributeConverter(definition));
+            evt.stop();
+        });
+    }
 }

package/src/integrations/table.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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 with {@link module:table/table~Table Table} feature.
+ */
+export default class TableElementSupport extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableElementSupport';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}