@ckeditor/ckeditor5-html-support 39.0.2 → 40.0.0

package/src/integrations/documentlist.js

@@ -1,203 +1,178 @@
-/**
- * @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 { getHtmlAttributeName, setViewAttributes } from '../utils';
-import DataFilter from '../datafilter';
-/**
- * Provides the General HTML Support integration with the {@link module:list/documentlist~DocumentList Document List} feature.
- */
-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');
-        const viewElements = ['ul', 'ol', 'li'];
-        // Register downcast strategy.
-        // Note that this must be done before document list editing registers conversion in afterInit.
-        documentListEditing.registerDowncastStrategy({
-            scope: 'item',
-            attributeName: 'htmlLiAttributes',
-            setAttributeOnDowncast: setViewAttributes
-        });
-        documentListEditing.registerDowncastStrategy({
-            scope: 'list',
-            attributeName: 'htmlUlAttributes',
-            setAttributeOnDowncast: setViewAttributes
-        });
-        documentListEditing.registerDowncastStrategy({
-            scope: 'list',
-            attributeName: 'htmlOlAttributes',
-            setAttributeOnDowncast: setViewAttributes
-        });
-        dataFilter.on('register', (evt, definition) => {
-            if (!viewElements.includes(definition.view)) {
-                return;
-            }
-            evt.stop();
-            // Do not register same converters twice.
-            if (schema.checkAttribute('$block', 'htmlLiAttributes')) {
-                return;
-            }
-            const allowAttributes = viewElements.map(element => getHtmlAttributeName(element));
-            schema.extend('$block', { allowAttributes });
-            schema.extend('$blockObject', { allowAttributes });
-            schema.extend('$container', { allowAttributes });
-            conversion.for('upcast').add(dispatcher => {
-                dispatcher.on('element:ul', viewToModelListAttributeConverter('htmlUlAttributes', dataFilter), { priority: 'low' });
-                dispatcher.on('element:ol', viewToModelListAttributeConverter('htmlOlAttributes', 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 attribute = getAttributeFromListType(previousNodeInList.getAttribute('listType'));
-                    const value = previousNodeInList.getAttribute(attribute);
-                    if (!isEqual(node.getAttribute(attribute), value) &&
-                        writer.model.schema.checkAttribute(node, attribute)) {
-                        writer.setAttribute(attribute, value, node);
-                        evt.return = true;
-                    }
-                }
-                if (previousNodeInList.getAttribute('listItemId') == node.getAttribute('listItemId')) {
-                    const value = previousNodeInList.getAttribute('htmlLiAttributes');
-                    if (!isEqual(node.getAttribute('htmlLiAttributes'), value) &&
-                        writer.model.schema.checkAttribute(node, 'htmlLiAttributes')) {
-                        writer.setAttribute('htmlLiAttributes', value, node);
-                        evt.return = true;
-                    }
-                }
-            }
-        });
-        // Remove `ol` attributes from `ul` elements and vice versa.
-        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
-            for (const { node } of listNodes) {
-                const listType = node.getAttribute('listType');
-                if (listType === 'bulleted' && node.getAttribute('htmlOlAttributes')) {
-                    writer.removeAttribute('htmlOlAttributes', node);
-                    evt.return = true;
-                }
-                if (listType === 'numbered' && node.getAttribute('htmlUlAttributes')) {
-                    writer.removeAttribute('htmlUlAttributes', 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) {
-                    const attribute = getAttributeFromListType(node.getAttribute('listType'));
-                    if (!editor.model.schema.checkAttribute(node, attribute)) {
-                        continue;
-                    }
-                    // 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(attribute, {}, node);
-                }
-            });
-        });
-    }
-}
-/**
- * View-to-model conversion helper preserving allowed attributes on {@link TODO}
- * feature model element.
- *
- * @returns 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;
-            }
-            if (conversionApi.writer.model.schema.checkAttribute(item, attributeName)) {
-                conversionApi.writer.setAttribute(attributeName, viewAttributes || {}, item);
-            }
-        }
-    };
-}
-/**
- * Returns HTML attribute name based on provided list type.
- */
-function getAttributeFromListType(listType) {
-    return listType === 'bulleted' ?
-        'htmlUlAttributes' :
-        'htmlOlAttributes';
-}
+/**
+ * @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 { getHtmlAttributeName, setViewAttributes } from '../utils';
+import DataFilter from '../datafilter';
+/**
+ * Provides the General HTML Support integration with the {@link module:list/documentlist~DocumentList Document List} feature.
+ */
+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');
+        const viewElements = ['ul', 'ol', 'li'];
+        // Register downcast strategy.
+        // Note that this must be done before document list editing registers conversion in afterInit.
+        documentListEditing.registerDowncastStrategy({
+            scope: 'item',
+            attributeName: 'htmlLiAttributes',
+            setAttributeOnDowncast: setViewAttributes
+        });
+        documentListEditing.registerDowncastStrategy({
+            scope: 'list',
+            attributeName: 'htmlUlAttributes',
+            setAttributeOnDowncast: setViewAttributes
+        });
+        documentListEditing.registerDowncastStrategy({
+            scope: 'list',
+            attributeName: 'htmlOlAttributes',
+            setAttributeOnDowncast: setViewAttributes
+        });
+        dataFilter.on('register', (evt, definition) => {
+            if (!viewElements.includes(definition.view)) {
+                return;
+            }
+            evt.stop();
+            // Do not register same converters twice.
+            if (schema.checkAttribute('$block', 'htmlLiAttributes')) {
+                return;
+            }
+            const allowAttributes = viewElements.map(element => getHtmlAttributeName(element));
+            schema.extend('$listItem', { allowAttributes });
+            conversion.for('upcast').add(dispatcher => {
+                dispatcher.on('element:ul', viewToModelListAttributeConverter('htmlUlAttributes', dataFilter), { priority: 'low' });
+                dispatcher.on('element:ol', viewToModelListAttributeConverter('htmlOlAttributes', 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.
+        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
+            for (const { node, previousNodeInList } of listNodes) {
+                // This is a first item of a nested list.
+                if (!previousNodeInList) {
+                    continue;
+                }
+                if (previousNodeInList.getAttribute('listType') == node.getAttribute('listType')) {
+                    const attribute = getAttributeFromListType(previousNodeInList.getAttribute('listType'));
+                    const value = previousNodeInList.getAttribute(attribute);
+                    if (!isEqual(node.getAttribute(attribute), value) &&
+                        writer.model.schema.checkAttribute(node, attribute)) {
+                        writer.setAttribute(attribute, value, node);
+                        evt.return = true;
+                    }
+                }
+                if (previousNodeInList.getAttribute('listItemId') == node.getAttribute('listItemId')) {
+                    const value = previousNodeInList.getAttribute('htmlLiAttributes');
+                    if (!isEqual(node.getAttribute('htmlLiAttributes'), value) &&
+                        writer.model.schema.checkAttribute(node, 'htmlLiAttributes')) {
+                        writer.setAttribute('htmlLiAttributes', value, node);
+                        evt.return = true;
+                    }
+                }
+            }
+        });
+        // Remove `ol` attributes from `ul` elements and vice versa.
+        documentListEditing.on('postFixer', (evt, { listNodes, writer }) => {
+            for (const { node } of listNodes) {
+                const listType = node.getAttribute('listType');
+                if (listType !== 'numbered' && node.getAttribute('htmlOlAttributes')) {
+                    writer.removeAttribute('htmlOlAttributes', node);
+                    evt.return = true;
+                }
+                if (listType === 'numbered' && node.getAttribute('htmlUlAttributes')) {
+                    writer.removeAttribute('htmlUlAttributes', 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) {
+                    const attribute = getAttributeFromListType(node.getAttribute('listType'));
+                    if (!editor.model.schema.checkAttribute(node, attribute)) {
+                        continue;
+                    }
+                    // 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(attribute, {}, node);
+                }
+            });
+        });
+    }
+}
+/**
+ * View-to-model conversion helper preserving allowed attributes on {@link TODO}
+ * feature model element.
+ *
+ * @returns 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;
+            }
+            if (conversionApi.writer.model.schema.checkAttribute(item, attributeName)) {
+                conversionApi.writer.setAttribute(attributeName, viewAttributes || {}, item);
+            }
+        }
+    };
+}
+/**
+ * Returns HTML attribute name based on provided list type.
+ */
+function getAttributeFromListType(listType) {
+    return listType === 'numbered' ?
+        'htmlOlAttributes' :
+        'htmlUlAttributes';
+}

package/src/integrations/dualcontent.d.ts

@@ -1,45 +1,45 @@
-/**
- * @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 } from 'ckeditor5/src/core';
-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).
- *
- * 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(): readonly [typeof DataFilter];
-    /**
-     * @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;
-}
+/**
+ * @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 } from 'ckeditor5/src/core';
+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).
+ *
+ * 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(): readonly [typeof DataFilter];
+    /**
+     * @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;
+}