@ckeditor/ckeditor5-engine 35.4.0 → 36.0.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor 5 editing engine** – https://github.com/ckeditor/ckeditor5-engine <br>
-Copyright (c) 2003-2022, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-engine",
-  "version": "35.4.0",
+  "version": "36.0.0",
   "description": "The editing engine of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "wysiwyg",
@@ -23,30 +23,30 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-utils": "^35.4.0",
+    "@ckeditor/ckeditor5-utils": "^36.0.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^35.4.0",
-    "@ckeditor/ckeditor5-block-quote": "^35.4.0",
-    "@ckeditor/ckeditor5-clipboard": "^35.4.0",
-    "@ckeditor/ckeditor5-cloud-services": "^35.4.0",
-    "@ckeditor/ckeditor5-core": "^35.4.0",
-    "@ckeditor/ckeditor5-editor-classic": "^35.4.0",
-    "@ckeditor/ckeditor5-enter": "^35.4.0",
-    "@ckeditor/ckeditor5-essentials": "^35.4.0",
-    "@ckeditor/ckeditor5-heading": "^35.4.0",
-    "@ckeditor/ckeditor5-image": "^35.4.0",
-    "@ckeditor/ckeditor5-link": "^35.4.0",
-    "@ckeditor/ckeditor5-list": "^35.4.0",
-    "@ckeditor/ckeditor5-mention": "^35.4.0",
-    "@ckeditor/ckeditor5-paragraph": "^35.4.0",
-    "@ckeditor/ckeditor5-table": "^35.4.0",
-    "@ckeditor/ckeditor5-theme-lark": "^35.4.0",
-    "@ckeditor/ckeditor5-typing": "^35.4.0",
-    "@ckeditor/ckeditor5-ui": "^35.4.0",
-    "@ckeditor/ckeditor5-undo": "^35.4.0",
-    "@ckeditor/ckeditor5-widget": "^35.4.0",
+    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
+    "@ckeditor/ckeditor5-block-quote": "^36.0.0",
+    "@ckeditor/ckeditor5-clipboard": "^36.0.0",
+    "@ckeditor/ckeditor5-cloud-services": "^36.0.0",
+    "@ckeditor/ckeditor5-core": "^36.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
+    "@ckeditor/ckeditor5-enter": "^36.0.0",
+    "@ckeditor/ckeditor5-essentials": "^36.0.0",
+    "@ckeditor/ckeditor5-heading": "^36.0.0",
+    "@ckeditor/ckeditor5-image": "^36.0.0",
+    "@ckeditor/ckeditor5-link": "^36.0.0",
+    "@ckeditor/ckeditor5-list": "^36.0.0",
+    "@ckeditor/ckeditor5-mention": "^36.0.0",
+    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
+    "@ckeditor/ckeditor5-table": "^36.0.0",
+    "@ckeditor/ckeditor5-theme-lark": "^36.0.0",
+    "@ckeditor/ckeditor5-typing": "^36.0.0",
+    "@ckeditor/ckeditor5-ui": "^36.0.0",
+    "@ckeditor/ckeditor5-undo": "^36.0.0",
+    "@ckeditor/ckeditor5-widget": "^36.0.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"

package/src/controller/datacontroller.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
@@ -128,6 +128,8 @@ export default class DataController extends EmitterMixin() {
         ObservableMixin().prototype.decorate.call(this, 'init');
         ObservableMixin().prototype.decorate.call(this, 'set');
         ObservableMixin().prototype.decorate.call(this, 'get');
+        ObservableMixin().prototype.decorate.call(this, 'toView');
+        ObservableMixin().prototype.decorate.call(this, 'toModel');
         // Fire the `ready` event when the initialization has completed. Such low-level listener offers the possibility
         // to plug into the initialization pipeline without interrupting the initialization flow.
         this.on('init', () => {
@@ -196,6 +198,7 @@ export default class DataController extends EmitterMixin() {
      * converters attached to {@link #downcastDispatcher} into a
      * {@link module:engine/view/documentfragment~DocumentFragment view document fragment}.
      *
+     * @fires toView
      * @param {module:engine/model/element~Element|module:engine/model/documentfragment~DocumentFragment} modelElementOrFragment
      * Element or document fragment whose content will be converted.
      * @param {Object} [options={}] Additional configuration that will be available through the
@@ -370,6 +373,7 @@ export default class DataController extends EmitterMixin() {
      * When marker elements were converted during the conversion process, it will be set as a document fragment's
      * {@link module:engine/model/documentfragment~DocumentFragment#markers static markers map}.
      *
+     * @fires toModel
      * @param {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment} viewElementOrFragment
      * The element or document fragment whose content will be converted.
      * @param {module:engine/model/schema~SchemaContextDefinition} [context='$root'] Base context in which the view will

package/src/controller/editingcontroller.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/conversion.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/conversionhelpers.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/downcastdispatcher.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/downcasthelpers.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/mapper.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/modelconsumable.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/upcastdispatcher.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/conversion/upcasthelpers.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 Matcher from '../view/matcher';
@@ -454,7 +454,14 @@ export function convertText() {
             if (data.viewItem.data.trim().length == 0) {
                 return;
             }
+            // Wrap `$text` in paragraph and include any marker that is directly before `$text`. See #13053.
+            const nodeBefore = position.nodeBefore;
             position = wrapInParagraph(position, writer);
+            if (nodeBefore && nodeBefore.is('element', '$marker')) {
+                // Move `$marker` to the paragraph.
+                writer.move(writer.createRangeOn(nodeBefore), position);
+                position = writer.createPositionAfter(nodeBefore);
+            }
         }
         consumable.consume(data.viewItem);
         const text = writer.createText(data.viewItem.data);

package/src/conversion/viewconsumable.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dataprocessor/basichtmlwriter.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dataprocessor/dataprocessor.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 export {};

package/src/dataprocessor/htmldataprocessor.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
@@ -97,7 +97,6 @@ export default class HtmlDataProcessor {
      * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
      * the provided data.
      *
-     * @private
      * @param {String} data
      * @returns {DocumentFragment}
      */

package/src/dataprocessor/htmlwriter.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 export {};

package/src/dataprocessor/xmldataprocessor.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dev-utils/model.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dev-utils/operationreplayer.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dev-utils/utils.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/dev-utils/view.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**

package/src/index.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
@@ -11,7 +11,6 @@ export { default as EditingController } from './controller/editingcontroller';
 export { default as DataController } from './controller/datacontroller';
 // Conversion.
 export { default as Conversion } from './conversion/conversion';
-// DataProcessor.
 export { default as HtmlDataProcessor } from './dataprocessor/htmldataprocessor';
 export { default as InsertOperation } from './model/operation/insertoperation';
 export { default as MarkerOperation } from './model/operation/markeroperation';
@@ -45,12 +44,14 @@ export { default as ViewEmptyElement } from './view/emptyelement';
 export { default as ViewRawElement } from './view/rawelement';
 export { default as ViewUIElement } from './view/uielement';
 export { default as ViewDocumentFragment } from './view/documentfragment';
+export { default as AttributeElement } from './view/attributeelement';
 export { getFillerOffset } from './view/containerelement';
 // View / Observer.
 export { default as Observer } from './view/observer/observer';
 export { default as ClickObserver } from './view/observer/clickobserver';
 export { default as DomEventObserver } from './view/observer/domeventobserver';
 export { default as MouseObserver } from './view/observer/mouseobserver';
+export { default as TabObserver } from './view/observer/tabobserver';
 export { default as DowncastWriter } from './view/downcastwriter';
 export { default as UpcastWriter } from './view/upcastwriter';
 export { default as Matcher } from './view/matcher';

package/src/model/batch.js

@@ -1,5 +1,5 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
 /**
@@ -11,9 +11,11 @@ import { logWarning } from '@ckeditor/ckeditor5-utils';
  * grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want
  * to extend a given undo step, you can add more changes to the batch using {@link module:engine/model/model~Model#enqueueChange}:
  *
- *		model.enqueueChange( batch, writer => {
- *			writer.insertText( 'foo', paragraph, 'end' );
- *		} );
+ * ```ts
+ * model.enqueueChange( batch, writer => {
+ * 	writer.insertText( 'foo', paragraph, 'end' );
+ * } );
+ * ```
  *
  * @see module:engine/model/model~Model#enqueueChange
  * @see module:engine/model/model~Model#change
@@ -24,13 +26,8 @@ export default class Batch {
      *
      * @see module:engine/model/model~Model#enqueueChange
      * @see module:engine/model/model~Model#change
-     * @param {Object} [type] A set of flags that specify the type of the batch. Batch type can alter how some of the features work
+     * @param type A set of flags that specify the type of the batch. Batch type can alter how some of the features work
      * when encountering a given `Batch` instance (for example, when a feature listens to applied operations).
-     * @param {Boolean} [type.isUndoable=true] Whether a batch can be undone through undo feature.
-     * @param {Boolean} [type.isLocal=true] Whether a batch includes operations created locally (`true`) or operations created on
-     * other, remote editors (`false`).
-     * @param {Boolean} [type.isUndo=false] Whether a batch was created by the undo feature and undoes other operations.
-     * @param {Boolean} [type.isTyping=false] Whether a batch includes operations connected with a typing action.
      */
     constructor(type = {}) {
         if (typeof type === 'string') {
@@ -45,40 +42,10 @@ export default class Batch {
             logWarning('batch-constructor-deprecated-string-type');
         }
         const { isUndoable = true, isLocal = true, isUndo = false, isTyping = false } = type;
-        /**
-         * An array of operations that compose this batch.
-         *
-         * @readonly
-         * @type {Array.<module:engine/model/operation/operation~Operation>}
-         */
         this.operations = [];
-        /**
-         * Whether the batch can be undone through the undo feature.
-         *
-         * @readonly
-         * @type {Boolean}
-         */
         this.isUndoable = isUndoable;
-        /**
-         * Whether the batch includes operations created locally (`true`) or operations created on other, remote editors (`false`).
-         *
-         * @readonly
-         * @type {Boolean}
-         */
         this.isLocal = isLocal;
-        /**
-         * Whether the batch was created by the undo feature and undoes other operations.
-         *
-         * @readonly
-         * @type {Boolean}
-         */
         this.isUndo = isUndo;
-        /**
-         * Whether the batch includes operations connected with typing.
-         *
-         * @readonly
-         * @type {Boolean}
-         */
         this.isTyping = isTyping;
     }
     /**
@@ -92,7 +59,6 @@ export default class Batch {
      * changes.
      *
      * @deprecated
-     * @type {'default'}
      */
     get type() {
         /**
@@ -107,9 +73,6 @@ export default class Batch {
     /**
      * Returns the base version of this batch, which is equal to the base version of the first operation in the batch.
      * If there are no operations in the batch or neither operation has the base version set, it returns `null`.
-     *
-     * @readonly
-     * @type {Number|null}
      */
     get baseVersion() {
         for (const op of this.operations) {
@@ -122,8 +85,8 @@ export default class Batch {
     /**
      * Adds an operation to the batch instance.
      *
-     * @param {module:engine/model/operation/operation~Operation} operation An operation to add.
-     * @returns {module:engine/model/operation/operation~Operation} The added operation.
+     * @param operation An operation to add.
+     * @returns The added operation.
      */
     addOperation(operation) {
         operation.batch = this;