@ckeditor/ckeditor5-engine 38.2.0-alpha.0 → 38.2.0-alpha.1

package/src/model/utils/insertcontent.js

@@ -5,12 +5,12 @@
 /**
  * @module engine/model/utils/insertcontent
  */
-import DocumentSelection from '../documentselection';
-import Element from '../element';
-import LivePosition from '../liveposition';
-import LiveRange from '../liverange';
-import Position from '../position';
-import Range from '../range';
+import DocumentSelection from '../documentselection.js';
+import Element from '../element.js';
+import LivePosition from '../liveposition.js';
+import LiveRange from '../liverange.js';
+import Position from '../position.js';
+import Range from '../range.js';
 import { CKEditorError } from '@ckeditor/ckeditor5-utils';
 /**
  * Inserts content into the editor (specified selection) as one would expect the paste functionality to work.

package/src/model/utils/insertobject.d.ts

@@ -2,11 +2,11 @@
  * @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 type DocumentSelection from '../documentselection';
-import type Selection from '../selection';
-import type Element from '../element';
-import type Model from '../model';
-import type Range from '../range';
+import type DocumentSelection from '../documentselection.js';
+import type Selection from '../selection.js';
+import type Element from '../element.js';
+import type Model from '../model.js';
+import type Range from '../range.js';
 /**
  * Inserts an {@glink framework/deep-dive/schema#object-elements object element} at a specific position in the editor content.
  *

package/src/model/utils/insertobject.js

@@ -5,7 +5,7 @@
 /**
  * @module engine/model/utils/insertobject
  */
-import { findOptimalInsertionRange } from './findoptimalinsertionrange';
+import { findOptimalInsertionRange } from './findoptimalinsertionrange.js';
 import { CKEditorError, first } from '@ckeditor/ckeditor5-utils';
 /**
  * Inserts an {@glink framework/deep-dive/schema#object-elements object element} at a specific position in the editor content.

package/src/model/utils/modifyselection.d.ts

@@ -5,9 +5,9 @@
 /**
  * @module engine/model/utils/modifyselection
  */
-import DocumentSelection from '../documentselection';
-import type Model from '../model';
-import type Selection from '../selection';
+import DocumentSelection from '../documentselection.js';
+import type Model from '../model.js';
+import type Selection from '../selection.js';
 /**
  * Modifies the selection. Currently, the supported modifications are:
  *

package/src/model/utils/modifyselection.js

@@ -5,10 +5,10 @@
 /**
  * @module engine/model/utils/modifyselection
  */
-import DocumentSelection from '../documentselection';
-import Position from '../position';
-import Range from '../range';
-import TreeWalker from '../treewalker';
+import DocumentSelection from '../documentselection.js';
+import Position from '../position.js';
+import Range from '../range.js';
+import TreeWalker from '../treewalker.js';
 import { isInsideSurrogatePair, isInsideCombinedSymbol, isInsideEmojiSequence } from '@ckeditor/ckeditor5-utils';
 const wordBoundaryCharacters = ' ,.?!:;"-()';
 /**

package/src/model/utils/selection-post-fixer.d.ts

@@ -2,9 +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
  */
-import Range from '../range';
-import type Model from '../model';
-import type Schema from '../schema';
+import Range from '../range.js';
+import type Model from '../model.js';
+import type Schema from '../schema.js';
 /**
  * Injects selection post-fixer to the model.
  *

package/src/model/utils/selection-post-fixer.js

@@ -5,8 +5,8 @@
 /**
  * @module engine/model/utils/selection-post-fixer
  */
-import Position from '../position';
-import Range from '../range';
+import Position from '../position.js';
+import Range from '../range.js';
 /**
  * Injects selection post-fixer to the model.
  *

package/src/model/writer.d.ts

@@ -2,18 +2,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
  */
-import DocumentFragment from './documentfragment';
-import Element from './element';
-import Position, { type PositionOffset, type PositionStickiness } from './position';
-import Range from './range';
-import RootElement from './rootelement';
-import Text from './text';
-import type { Marker } from './markercollection';
-import type { default as Selection, PlaceOrOffset, Selectable } from './selection';
-import type Batch from './batch';
-import type Item from './item';
-import type Model from './model';
-import type { default as Node, NodeAttributes } from './node';
+import DocumentFragment from './documentfragment.js';
+import Element from './element.js';
+import Position, { type PositionOffset, type PositionStickiness } from './position.js';
+import Range from './range.js';
+import RootElement from './rootelement.js';
+import Text from './text.js';
+import type { Marker } from './markercollection.js';
+import type { default as Selection, PlaceOrOffset, Selectable } from './selection.js';
+import type Batch from './batch.js';
+import type Item from './item.js';
+import type Model from './model.js';
+import type { default as Node, NodeAttributes } from './node.js';
 /**
  * The model can only be modified by using the writer. It should be used whenever you want to create a node, modify
  * child nodes, attributes or text, set the selection's position and its attributes.

package/src/model/writer.js

@@ -5,23 +5,23 @@
 /**
  * @module engine/model/writer
  */
-import AttributeOperation from './operation/attributeoperation';
-import DetachOperation from './operation/detachoperation';
-import InsertOperation from './operation/insertoperation';
-import MarkerOperation from './operation/markeroperation';
-import MergeOperation from './operation/mergeoperation';
-import MoveOperation from './operation/moveoperation';
-import RenameOperation from './operation/renameoperation';
-import RootAttributeOperation from './operation/rootattributeoperation';
-import RootOperation from './operation/rootoperation';
-import SplitOperation from './operation/splitoperation';
-import DocumentFragment from './documentfragment';
-import DocumentSelection from './documentselection';
-import Element from './element';
-import Position from './position';
-import Range from './range';
-import RootElement from './rootelement';
-import Text from './text';
+import AttributeOperation from './operation/attributeoperation.js';
+import DetachOperation from './operation/detachoperation.js';
+import InsertOperation from './operation/insertoperation.js';
+import MarkerOperation from './operation/markeroperation.js';
+import MergeOperation from './operation/mergeoperation.js';
+import MoveOperation from './operation/moveoperation.js';
+import RenameOperation from './operation/renameoperation.js';
+import RootAttributeOperation from './operation/rootattributeoperation.js';
+import RootOperation from './operation/rootoperation.js';
+import SplitOperation from './operation/splitoperation.js';
+import DocumentFragment from './documentfragment.js';
+import DocumentSelection from './documentselection.js';
+import Element from './element.js';
+import Position from './position.js';
+import Range from './range.js';
+import RootElement from './rootelement.js';
+import Text from './text.js';
 import { CKEditorError, logWarning, toMap } from '@ckeditor/ckeditor5-utils';
 /**
  * The model can only be modified by using the writer. It should be used whenever you want to create a node, modify

package/src/view/attributeelement.d.ts

@@ -5,9 +5,9 @@
 /**
  * @module engine/view/attributeelement
  */
-import Element, { type ElementAttributes } from './element';
-import type Document from './document';
-import type Node from './node';
+import Element, { type ElementAttributes } from './element.js';
+import type Document from './document.js';
+import type Node from './node.js';
 /**
  * Attribute elements are used to represent formatting elements in the view (think – `<b>`, `<span style="font-size: 2em">`, etc.).
  * Most often they are created when downcasting model text attributes.

package/src/view/attributeelement.js

@@ -5,7 +5,7 @@
 /**
  * @module engine/view/attributeelement
  */
-import Element from './element';
+import Element from './element.js';
 import { CKEditorError } from '@ckeditor/ckeditor5-utils';
 // Default attribute priority.
 const DEFAULT_PRIORITY = 10;

package/src/view/containerelement.d.ts

@@ -5,9 +5,9 @@
 /**
  * @module engine/view/containerelement
  */
-import Element, { type ElementAttributes } from './element';
-import type Document from './document';
-import type Node from './node';
+import Element, { type ElementAttributes } from './element.js';
+import type Document from './document.js';
+import type Node from './node.js';
 /**
  * Containers are elements which define document structure. They define boundaries for
  * {@link module:engine/view/attributeelement~AttributeElement attributes}. They are mostly used for block elements like `<p>` or `<div>`.

package/src/view/containerelement.js

@@ -5,7 +5,7 @@
 /**
  * @module engine/view/containerelement
  */
-import Element from './element';
+import Element from './element.js';
 /**
  * Containers are elements which define document structure. They define boundaries for
  * {@link module:engine/view/attributeelement~AttributeElement attributes}. They are mostly used for block elements like `<p>` or `<div>`.

package/src/view/document.d.ts

@@ -5,11 +5,11 @@
 /**
  * @module engine/view/document
  */
-import DocumentSelection from './documentselection';
+import DocumentSelection from './documentselection.js';
 import { Collection } from '@ckeditor/ckeditor5-utils';
-import type { StylesProcessor } from './stylesmap';
-import type RootEditableElement from './rooteditableelement';
-import type DowncastWriter from './downcastwriter';
+import type { StylesProcessor } from './stylesmap.js';
+import type RootEditableElement from './rooteditableelement.js';
+import type DowncastWriter from './downcastwriter.js';
 declare const Document_base: import("@ckeditor/ckeditor5-utils").Mixed<{
     new (): import("@ckeditor/ckeditor5-utils").Observable;
     prototype: import("@ckeditor/ckeditor5-utils").Observable;

package/src/view/document.js

@@ -5,8 +5,8 @@
 /**
  * @module engine/view/document
  */
-import DocumentSelection from './documentselection';
-import BubblingEmitterMixin from './observer/bubblingemittermixin';
+import DocumentSelection from './documentselection.js';
+import BubblingEmitterMixin from './observer/bubblingemittermixin.js';
 import { Collection, ObservableMixin } from '@ckeditor/ckeditor5-utils';
 // @if CK_DEBUG_ENGINE // const { logDocument } = require( '../dev-utils/utils' );
 /**

package/src/view/documentfragment.d.ts

@@ -5,10 +5,10 @@
 /**
  * @module engine/view/documentfragment
  */
-import TypeCheckable from './typecheckable';
-import type { default as Document, ChangeType } from './document';
-import type Item from './item';
-import type Node from './node';
+import TypeCheckable from './typecheckable.js';
+import type { default as Document, ChangeType } from './document.js';
+import type Item from './item.js';
+import type Node from './node.js';
 declare const DocumentFragment_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
  * Document fragment.

package/src/view/documentfragment.js

@@ -5,9 +5,9 @@
 /**
  * @module engine/view/documentfragment
  */
-import TypeCheckable from './typecheckable';
-import Text from './text';
-import TextProxy from './textproxy';
+import TypeCheckable from './typecheckable.js';
+import Text from './text.js';
+import TextProxy from './textproxy.js';
 import { EmitterMixin, isIterable } from '@ckeditor/ckeditor5-utils';
 /**
  * Document fragment.

package/src/view/documentselection.d.ts

@@ -5,14 +5,14 @@
 /**
  * @module engine/view/documentselection
  */
-import TypeCheckable from './typecheckable';
-import Selection, { type PlaceOrOffset, type Selectable, type SelectionOptions, type ViewSelectionChangeEvent } from './selection';
-import type EditableElement from './editableelement';
-import type Element from './element';
-import type Node from './node';
-import type Item from './item';
-import type { default as Position, PositionOffset } from './position';
-import type Range from './range';
+import TypeCheckable from './typecheckable.js';
+import Selection, { type PlaceOrOffset, type Selectable, type SelectionOptions, type ViewSelectionChangeEvent } from './selection.js';
+import type EditableElement from './editableelement.js';
+import type Element from './element.js';
+import type Node from './node.js';
+import type Item from './item.js';
+import type { default as Position, PositionOffset } from './position.js';
+import type Range from './range.js';
 declare const DocumentSelection_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
  * Class representing the document selection in the view.

package/src/view/documentselection.js

@@ -5,8 +5,8 @@
 /**
  * @module engine/view/documentselection
  */
-import TypeCheckable from './typecheckable';
-import Selection from './selection';
+import TypeCheckable from './typecheckable.js';
+import Selection from './selection.js';
 import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
 /**
  * Class representing the document selection in the view.

package/src/view/domconverter.d.ts

@@ -5,19 +5,19 @@
 /**
  * @module engine/view/domconverter
  */
-import ViewText from './text';
-import ViewElement from './element';
-import ViewUIElement from './uielement';
-import ViewPosition from './position';
-import ViewRange from './range';
-import ViewSelection from './selection';
-import ViewDocumentFragment from './documentfragment';
-import { type MatcherPattern } from './matcher';
-import type ViewNode from './node';
-import type Document from './document';
-import type DocumentSelection from './documentselection';
-import type EditableElement from './editableelement';
-import type ViewRawElement from './rawelement';
+import ViewText from './text.js';
+import ViewElement from './element.js';
+import ViewUIElement from './uielement.js';
+import ViewPosition from './position.js';
+import ViewRange from './range.js';
+import ViewSelection from './selection.js';
+import ViewDocumentFragment from './documentfragment.js';
+import { type MatcherPattern } from './matcher.js';
+import type ViewNode from './node.js';
+import type Document from './document.js';
+import type DocumentSelection from './documentselection.js';
+import type EditableElement from './editableelement.js';
+import type ViewRawElement from './rawelement.js';
 type DomNode = globalThis.Node;
 type DomElement = globalThis.HTMLElement;
 type DomDocumentFragment = globalThis.DocumentFragment;
@@ -98,9 +98,9 @@ export default class DomConverter {
      */
     private readonly _rawContentElementMatcher;
     /**
-     * A set of encountered raw content DOM nodes. It is used for preventing left trimming of the following text node.
+     * Matcher for inline object view elements. This is an extension of a simple {@link #inlineObjectElements} array of element names.
      */
-    private readonly _encounteredRawContentDomNodes;
+    private readonly _inlineObjectElementMatcher;
     /**
      * Creates a DOM converter.
      *
@@ -269,9 +269,10 @@ export default class DomConverter {
      *
      * @param domElement Parent DOM element.
      * @param options See {@link module:engine/view/domconverter~DomConverter#domToView} options parameter.
+     * @param inlineNodes An array that will be populated with inline nodes. It's used internally for whitespace processing.
      * @returns View nodes.
      */
-    domChildrenToView(domElement: DomElement, options: Parameters<DomConverter['domToView']>[1]): IterableIterator<ViewNode>;
+    domChildrenToView(domElement: DomElement, options?: Parameters<DomConverter['domToView']>[1], inlineNodes?: Array<ViewNode>): IterableIterator<ViewNode>;
     /**
      * Converts DOM selection to view {@link module:engine/view/selection~Selection}.
      * Ranges which cannot be converted will be omitted.
@@ -459,6 +460,17 @@ export default class DomConverter {
      * be treated as raw data.
      */
     registerRawContentMatcher(pattern: MatcherPattern): void;
+    /**
+     * Registers a {@link module:engine/view/matcher~MatcherPattern} for inline object view elements.
+     *
+     * This is affecting how {@link module:engine/view/domconverter~DomConverter#domToView} and
+     * {@link module:engine/view/domconverter~DomConverter#domChildrenToView} process DOM nodes.
+     *
+     * This is an extension of a simple {@link #inlineObjectElements} array of element names.
+     *
+     * @param pattern Pattern matching a view element which should be treated as an inline object.
+     */
+    registerInlineObjectMatcher(pattern: MatcherPattern): void;
     /**
      * Returns the block {@link module:engine/view/filler filler} node based on the current {@link #blockFillerMode} setting.
      */
@@ -471,6 +483,24 @@ export default class DomConverter {
      * @returns `true` if given position is at a correct place for selection boundary, `false` otherwise.
      */
     private _isDomSelectionPositionCorrect;
+    /**
+     * Internal generator for {@link #domToView}. Also used by {@link #domChildrenToView}.
+     * Separates DOM nodes conversion from whitespaces processing.
+     *
+     * @param domNode DOM node or document fragment to transform.
+     * @param inlineNodes An array of recently encountered inline nodes truncated to the block element boundaries.
+     * Used later to process whitespaces.
+     */
+    private _domToView;
+    /**
+     * Internal helper that walks the list of inline view nodes already generated from DOM nodes
+     * and handles whitespaces and NBSPs.
+     *
+     * @param domParent The DOM parent of the given inline nodes. This should be a document fragment or
+     * a block element to whitespace processing start cleaning.
+     * @param inlineNodes An array of recently encountered inline nodes truncated to the block element boundaries.
+     */
+    private _processDomInlineNodes;
     /**
      * Takes text data from a given {@link module:engine/view/text~Text#data} and processes it so
      * it is correctly displayed in the DOM.
@@ -496,36 +526,6 @@ export default class DomConverter {
      * @returns `true` if given `node` ends with space, `false` otherwise.
      */
     private _nodeEndsWithSpace;
-    /**
-     * Takes text data from native `Text` node and processes it to a correct {@link module:engine/view/text~Text view text node} data.
-     *
-     * Following changes are done:
-     *
-     * * multiple whitespaces are replaced to a single space,
-     * * space at the beginning of a text node is removed if it is the first text node in its container
-     * element or if the previous text node ends with a space character,
-     * * space at the end of the text node is removed if there are two spaces at the end of a node or if next node
-     * starts with a space or if it is the last text node in its container
-     * * nbsps are converted to spaces.
-     *
-     * @param node DOM text node to process.
-     * @returns Processed data.
-     */
-    private _processDataFromDomText;
-    /**
-     * Helper function which checks if a DOM text node, preceded by the given `prevNode` should
-     * be trimmed from the left side.
-     *
-     * @param prevNode Either DOM text or `<br>` or one of `#inlineObjectElements`.
-     */
-    private _checkShouldLeftTrimDomText;
-    /**
-     * Helper function which checks if a DOM text node, succeeded by the given `nextNode` should
-     * be trimmed from the right side.
-     *
-     * @param nextNode Either DOM text or `<br>` or one of `#inlineObjectElements`.
-     */
-    private _checkShouldRightTrimDomText;
     /**
      * Helper function. For given {@link module:engine/view/text~Text view text node}, it finds previous or next sibling
      * that is contained in the same container element. If there is no such sibling, `null` is returned.
@@ -536,29 +536,13 @@ export default class DomConverter {
      */
     private _getTouchingInlineViewNode;
     /**
-     * Helper function. For the given text node, it finds the closest touching node which is either
-     * a text, `<br>` or an {@link #inlineObjectElements inline object}.
-     *
-     * If no such node is found, `null` is returned.
-     *
-     * For instance, in the following DOM structure:
-     *
-     * ```html
-     * <p>foo<b>bar</b><br>bom</p>
-     * ```
-     *
-     * * `foo` doesn't have its previous touching inline node (`null` is returned),
-     * * `foo`'s next touching inline node is `bar`
-     * * `bar`'s next touching inline node is `<br>`
-     *
-     * This method returns text nodes and `<br>` elements because these types of nodes affect how
-     * spaces in the given text node need to be converted.
+     * Returns `true` if a DOM node belongs to {@link #blockElements}. `false` otherwise.
      */
-    private _getTouchingInlineDomNode;
+    private _isBlockDomElement;
     /**
-     * Returns `true` if a DOM node belongs to {@link #blockElements}. `false` otherwise.
+     * Returns `true` if a view node belongs to {@link #blockElements}. `false` otherwise.
      */
-    private _isBlockElement;
+    private _isBlockViewElement;
     /**
      * Returns `true` if a DOM node belongs to {@link #inlineObjectElements}. `false` otherwise.
      */