@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

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

@@ -1,37 +1,37 @@
-/**
- * @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 Node from '../node';
-import type Position from '../position';
-import type Schema from '../schema';
-import type Writer from '../writer';
-/**
- * @module engine/model/utils/autoparagraphing
- */
-/**
- * Fixes all empty roots.
- *
- * @internal
- * @param writer The model writer.
- * @returns `true` if any change has been applied, `false` otherwise.
- */
-export declare function autoParagraphEmptyRoots(writer: Writer): boolean;
-/**
- * Checks if the given node wrapped with a paragraph would be accepted by the schema in the given position.
- *
- * @internal
- * @param position The position at which to check.
- * @param nodeOrType The child node or child type to check.
- * @param schema A schema instance used for element validation.
- */
-export declare function isParagraphable(position: Position, nodeOrType: Node | string, schema: Schema): boolean;
-/**
- * Inserts a new paragraph at the given position and returns a position inside that paragraph.
- *
- * @internal
- * @param position The position where a paragraph should be inserted.
- * @param writer The model writer.
- * @returns  Position inside the created paragraph.
- */
-export declare function wrapInParagraph(position: Position, writer: Writer): Position;
+/**
+ * @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 Node from '../node';
+import type Position from '../position';
+import type Schema from '../schema';
+import type Writer from '../writer';
+/**
+ * @module engine/model/utils/autoparagraphing
+ */
+/**
+ * Fixes all empty roots.
+ *
+ * @internal
+ * @param writer The model writer.
+ * @returns `true` if any change has been applied, `false` otherwise.
+ */
+export declare function autoParagraphEmptyRoots(writer: Writer): boolean;
+/**
+ * Checks if the given node wrapped with a paragraph would be accepted by the schema in the given position.
+ *
+ * @internal
+ * @param position The position at which to check.
+ * @param nodeOrType The child node or child type to check.
+ * @param schema A schema instance used for element validation.
+ */
+export declare function isParagraphable(position: Position, nodeOrType: Node | string, schema: Schema): boolean;
+/**
+ * Inserts a new paragraph at the given position and returns a position inside that paragraph.
+ *
+ * @internal
+ * @param position The position where a paragraph should be inserted.
+ * @param writer The model writer.
+ * @returns  Position inside the created paragraph.
+ */
+export declare function wrapInParagraph(position: Position, writer: Writer): Position;

package/src/model/utils/autoparagraphing.js

@@ -1,63 +1,63 @@
-/**
- * @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 engine/model/utils/autoparagraphing
- */
-/**
- * Fixes all empty roots.
- *
- * @internal
- * @param writer The model writer.
- * @returns `true` if any change has been applied, `false` otherwise.
- */
-export function autoParagraphEmptyRoots(writer) {
-    const { schema, document } = writer.model;
-    for (const root of document.getRoots()) {
-        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
- * @param position The position at which to check.
- * @param nodeOrType The child node or child type to check.
- * @param 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;
-}
-/**
- * Inserts a new paragraph at the given position and returns a position inside that paragraph.
- *
- * @internal
- * @param position The position where a paragraph should be inserted.
- * @param writer The model writer.
- * @returns  Position inside the created paragraph.
- */
-export function wrapInParagraph(position, writer) {
-    const paragraph = writer.createElement('paragraph');
-    writer.insert(paragraph, position);
-    return writer.createPositionAt(paragraph, 0);
-}
+/**
+ * @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 engine/model/utils/autoparagraphing
+ */
+/**
+ * Fixes all empty roots.
+ *
+ * @internal
+ * @param writer The model writer.
+ * @returns `true` if any change has been applied, `false` otherwise.
+ */
+export function autoParagraphEmptyRoots(writer) {
+    const { schema, document } = writer.model;
+    for (const root of document.getRoots()) {
+        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
+ * @param position The position at which to check.
+ * @param nodeOrType The child node or child type to check.
+ * @param 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;
+}
+/**
+ * Inserts a new paragraph at the given position and returns a position inside that paragraph.
+ *
+ * @internal
+ * @param position The position where a paragraph should be inserted.
+ * @param writer The model writer.
+ * @returns  Position inside the created paragraph.
+ */
+export function wrapInParagraph(position, writer) {
+    const paragraph = writer.createElement('paragraph');
+    writer.insert(paragraph, position);
+    return writer.createPositionAt(paragraph, 0);
+}

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

@@ -1,58 +1,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 engine/model/utils/deletecontent
- */
-import DocumentSelection from '../documentselection';
-import type Model from '../model';
-import type Selection from '../selection';
-/**
- * Deletes content of the selection and merge siblings. The resulting selection is always collapsed.
- *
- * **Note:** Use {@link module:engine/model/model~Model#deleteContent} instead of this function.
- * This function is only exposed to be reusable in algorithms
- * which change the {@link module:engine/model/model~Model#deleteContent}
- * method's behavior.
- *
- * @param model The model in context of which the insertion should be performed.
- * @param selection Selection of which the content should be deleted.
- * @param options.leaveUnmerged Whether to merge elements after removing the content of the selection.
- *
- * For example `<heading>x[x</heading><paragraph>y]y</paragraph>` will become:
- *
- * * `<heading>x^y</heading>` with the option disabled (`leaveUnmerged == false`)
- * * `<heading>x^</heading><paragraph>y</paragraph>` with enabled (`leaveUnmerged == true`).
- *
- * Note: {@link module:engine/model/schema~Schema#isObject object} and {@link module:engine/model/schema~Schema#isLimit limit}
- * elements will not be merged.
- *
- * @param options.doNotResetEntireContent Whether to skip replacing the entire content with a
- * paragraph when the entire content was selected.
- *
- * For example `<heading>[x</heading><paragraph>y]</paragraph>` will become:
- *
- * * `<paragraph>^</paragraph>` with the option disabled (`doNotResetEntireContent == false`)
- * * `<heading>^</heading>` with enabled (`doNotResetEntireContent == true`).
- *
- * @param options.doNotAutoparagraph Whether to create a paragraph if after content deletion selection is moved
- * to a place where text cannot be inserted.
- *
- * For example `<paragraph>x</paragraph>[<imageBlock src="foo.jpg"></imageBlock>]` will become:
- *
- * * `<paragraph>x</paragraph><paragraph>[]</paragraph>` with the option disabled (`doNotAutoparagraph == false`)
- * * `<paragraph>x</paragraph>[]` with the option enabled (`doNotAutoparagraph == true`).
- *
- * If you use this option you need to make sure to handle invalid selections yourself or leave
- * them to the selection post-fixer (may not always work).
- *
- * **Note:** If there is no valid position for the selection, the paragraph will always be created:
- *
- * `[<imageBlock src="foo.jpg"></imageBlock>]` -> `<paragraph>[]</paragraph>`.
- */
-export default function deleteContent(model: Model, selection: Selection | DocumentSelection, options?: {
-    leaveUnmerged?: boolean;
-    doNotResetEntireContent?: boolean;
-    doNotAutoparagraph?: boolean;
-}): void;
+/**
+ * @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 engine/model/utils/deletecontent
+ */
+import DocumentSelection from '../documentselection';
+import type Model from '../model';
+import type Selection from '../selection';
+/**
+ * Deletes content of the selection and merge siblings. The resulting selection is always collapsed.
+ *
+ * **Note:** Use {@link module:engine/model/model~Model#deleteContent} instead of this function.
+ * This function is only exposed to be reusable in algorithms
+ * which change the {@link module:engine/model/model~Model#deleteContent}
+ * method's behavior.
+ *
+ * @param model The model in context of which the insertion should be performed.
+ * @param selection Selection of which the content should be deleted.
+ * @param options.leaveUnmerged Whether to merge elements after removing the content of the selection.
+ *
+ * For example `<heading>x[x</heading><paragraph>y]y</paragraph>` will become:
+ *
+ * * `<heading>x^y</heading>` with the option disabled (`leaveUnmerged == false`)
+ * * `<heading>x^</heading><paragraph>y</paragraph>` with enabled (`leaveUnmerged == true`).
+ *
+ * Note: {@link module:engine/model/schema~Schema#isObject object} and {@link module:engine/model/schema~Schema#isLimit limit}
+ * elements will not be merged.
+ *
+ * @param options.doNotResetEntireContent Whether to skip replacing the entire content with a
+ * paragraph when the entire content was selected.
+ *
+ * For example `<heading>[x</heading><paragraph>y]</paragraph>` will become:
+ *
+ * * `<paragraph>^</paragraph>` with the option disabled (`doNotResetEntireContent == false`)
+ * * `<heading>^</heading>` with enabled (`doNotResetEntireContent == true`).
+ *
+ * @param options.doNotAutoparagraph Whether to create a paragraph if after content deletion selection is moved
+ * to a place where text cannot be inserted.
+ *
+ * For example `<paragraph>x</paragraph>[<imageBlock src="foo.jpg"></imageBlock>]` will become:
+ *
+ * * `<paragraph>x</paragraph><paragraph>[]</paragraph>` with the option disabled (`doNotAutoparagraph == false`)
+ * * `<paragraph>x</paragraph>[]` with the option enabled (`doNotAutoparagraph == true`).
+ *
+ * If you use this option you need to make sure to handle invalid selections yourself or leave
+ * them to the selection post-fixer (may not always work).
+ *
+ * **Note:** If there is no valid position for the selection, the paragraph will always be created:
+ *
+ * `[<imageBlock src="foo.jpg"></imageBlock>]` -> `<paragraph>[]</paragraph>`.
+ */
+export default function deleteContent(model: Model, selection: Selection | DocumentSelection, options?: {
+    leaveUnmerged?: boolean;
+    doNotResetEntireContent?: boolean;
+    doNotAutoparagraph?: boolean;
+}): void;