@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/model/typecheckable.js

@@ -0,0 +1,16 @@
+/**
+ * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export default class TypeCheckable {
+    /* istanbul ignore next */
+    is() {
+        // There are a lot of overloads above.
+        // Overriding method in derived classes remove them and only `is( type: string ): boolean` is visible which we don't want.
+        // One option would be to copy them all to all classes, but that's ugly.
+        // It's best when TypeScript compiler doesn't see those overloads, except the one in the top base class.
+        // To overload a method, but not let the compiler see it, do after class definition:
+        // `MyClass.prototype.is = function( type: string ) {...}`
+        throw new Error('is() method is abstract');
+    }
+}

package/src/model/utils/autoparagraphing.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/model/utils/autoparagraphing
  */
-
 /**
  * Fixes all empty roots.
  *
@@ -14,52 +12,44 @@
  * @param {module:engine/model/writer~Writer} writer The model writer.
  * @returns {Boolean} `true` if any change has been applied, `false` otherwise.
  */
-export function autoParagraphEmptyRoots( writer ) {
-	const { schema, document } = writer.model;
-
-	for ( const rootName of document.getRootNames() ) {
-		const root = document.getRoot( rootName );
-
-		if ( root.isEmpty && !schema.checkChild( root, '$text' ) ) {
-			// If paragraph element is allowed in the root, create paragraph element.
-			if ( schema.checkChild( root, 'paragraph' ) ) {
-				writer.insertElement( 'paragraph', root );
-
-				// Other roots will get fixed in the next post-fixer round. Those will be triggered
-				// in the same batch no matter if this method was triggered by the post-fixing or not
-				// (the above insertElement call will trigger the post-fixers).
-				return true;
-			}
-		}
-	}
-
-	return false;
+export function autoParagraphEmptyRoots(writer) {
+    const { schema, document } = writer.model;
+    for (const rootName of document.getRootNames()) {
+        const root = document.getRoot(rootName);
+        if (root.isEmpty && !schema.checkChild(root, '$text')) {
+            // If paragraph element is allowed in the root, create paragraph element.
+            if (schema.checkChild(root, 'paragraph')) {
+                writer.insertElement('paragraph', root);
+                // Other roots will get fixed in the next post-fixer round. Those will be triggered
+                // in the same batch no matter if this method was triggered by the post-fixing or not
+                // (the above insertElement call will trigger the post-fixers).
+                return true;
+            }
+        }
+    }
+    return false;
 }
-
 /**
  * Checks if the given node wrapped with a paragraph would be accepted by the schema in the given position.
  *
+ * @internal
  * @protected
  * @param {module:engine/model/position~Position} position The position at which to check.
  * @param {module:engine/model/node~Node|String} nodeOrType The child node or child type to check.
  * @param {module:engine/model/schema~Schema} schema A schema instance used for element validation.
  */
-export function isParagraphable( position, nodeOrType, schema ) {
-	const context = schema.createContext( position );
-
-	// When paragraph is allowed in this context...
-	if ( !schema.checkChild( context, 'paragraph' ) ) {
-		return false;
-	}
-
-	// And a node would be allowed in this paragraph...
-	if ( !schema.checkChild( context.push( 'paragraph' ), nodeOrType ) ) {
-		return false;
-	}
-
-	return true;
+export function isParagraphable(position, nodeOrType, schema) {
+    const context = schema.createContext(position);
+    // When paragraph is allowed in this context...
+    if (!schema.checkChild(context, 'paragraph')) {
+        return false;
+    }
+    // And a node would be allowed in this paragraph...
+    if (!schema.checkChild(context.push('paragraph'), nodeOrType)) {
+        return false;
+    }
+    return true;
 }
-
 /**
  * Inserts a new paragraph at the given position and returns a position inside that paragraph.
  *
@@ -68,10 +58,8 @@ export function isParagraphable( position, nodeOrType, schema ) {
  * @param {module:engine/model/writer~Writer} writer The model writer.
  * @returns {module:engine/model/position~Position} Position inside the created paragraph.
  */
-export function wrapInParagraph( position, writer ) {
-	const paragraph = writer.createElement( 'paragraph' );
-
-	writer.insert( paragraph, position );
-
-	return writer.createPositionAt( paragraph, 0 );
+export function wrapInParagraph(position, writer) {
+    const paragraph = writer.createElement('paragraph');
+    writer.insert(paragraph, position);
+    return writer.createPositionAt(paragraph, 0);
 }