@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

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

@@ -1,44 +1,44 @@
-/**
- * @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';
-/**
- * Inserts an {@glink framework/deep-dive/schema#object-elements object element} at a specific position in the editor content.
- *
- * **Note:** Use {@link module:engine/model/model~Model#insertObject} instead of this function.
- * This function is only exposed to be reusable in algorithms which change the {@link module:engine/model/model~Model#insertObject}
- * method's behavior.
- *
- * **Note**: For more documentation and examples, see {@link module:engine/model/model~Model#insertObject}.
- *
- * @param model The model in context of which the insertion should be performed.
- * @param object An object to be inserted into the model document.
- * @param selectable A selectable where the content should be inserted. If not specified, the current
- * {@link module:engine/model/document~Document#selection document selection} will be used instead.
- * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
- * @param options Additional options.
- * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
- * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).
- * * When `'auto'`, the algorithm will decide whether to insert the object before or after `selectable` to avoid content splitting.
- * * When `'before'`, the closest position before `selectable` will be used that will not result in content splitting.
- * * When `'after'`, the closest position after `selectable` will be used that will not result in content splitting.
- *
- * Note that this option works only for block objects. Inline objects are inserted into text and do not split blocks.
- * @param options.setSelection An option that, when set, moves the
- * {@link module:engine/model/document~Document#selection document selection} after inserting the object.
- * * When `'on'`, the document selection will be set on the inserted object.
- * * When `'after'`, the document selection will move to the closest text node after the inserted object. If there is no
- * such text node, a paragraph will be created and the document selection will be moved inside it.
- * @returns A range which contains all the performed changes. This is a range that, if removed,
- * would return the model to the state before the insertion. If no changes were preformed by `insertObject()`, returns a range collapsed
- * at the insertion position.
- */
-export default function insertObject(model: Model, object: Element, selectable?: Selection | DocumentSelection | null, options?: {
-    findOptimalPosition?: 'auto' | 'before' | 'after';
-    setSelection?: 'on' | 'after';
-}): Range;
+/**
+ * @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';
+/**
+ * Inserts an {@glink framework/deep-dive/schema#object-elements object element} at a specific position in the editor content.
+ *
+ * **Note:** Use {@link module:engine/model/model~Model#insertObject} instead of this function.
+ * This function is only exposed to be reusable in algorithms which change the {@link module:engine/model/model~Model#insertObject}
+ * method's behavior.
+ *
+ * **Note**: For more documentation and examples, see {@link module:engine/model/model~Model#insertObject}.
+ *
+ * @param model The model in context of which the insertion should be performed.
+ * @param object An object to be inserted into the model document.
+ * @param selectable A selectable where the content should be inserted. If not specified, the current
+ * {@link module:engine/model/document~Document#selection document selection} will be used instead.
+ * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
+ * @param options Additional options.
+ * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
+ * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).
+ * * When `'auto'`, the algorithm will decide whether to insert the object before or after `selectable` to avoid content splitting.
+ * * When `'before'`, the closest position before `selectable` will be used that will not result in content splitting.
+ * * When `'after'`, the closest position after `selectable` will be used that will not result in content splitting.
+ *
+ * Note that this option works only for block objects. Inline objects are inserted into text and do not split blocks.
+ * @param options.setSelection An option that, when set, moves the
+ * {@link module:engine/model/document~Document#selection document selection} after inserting the object.
+ * * When `'on'`, the document selection will be set on the inserted object.
+ * * When `'after'`, the document selection will move to the closest text node after the inserted object. If there is no
+ * such text node, a paragraph will be created and the document selection will be moved inside it.
+ * @returns A range which contains all the performed changes. This is a range that, if removed,
+ * would return the model to the state before the insertion. If no changes were preformed by `insertObject()`, returns a range collapsed
+ * at the insertion position.
+ */
+export default function insertObject(model: Model, object: Element, selectable?: Selection | DocumentSelection | null, options?: {
+    findOptimalPosition?: 'auto' | 'before' | 'after';
+    setSelection?: 'on' | 'after';
+}): Range;

package/src/model/utils/insertobject.js

@@ -1,139 +1,139 @@
-/**
- * @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/insertobject
- */
-import { findOptimalInsertionRange } from './findoptimalinsertionrange';
-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.
- *
- * **Note:** Use {@link module:engine/model/model~Model#insertObject} instead of this function.
- * This function is only exposed to be reusable in algorithms which change the {@link module:engine/model/model~Model#insertObject}
- * method's behavior.
- *
- * **Note**: For more documentation and examples, see {@link module:engine/model/model~Model#insertObject}.
- *
- * @param model The model in context of which the insertion should be performed.
- * @param object An object to be inserted into the model document.
- * @param selectable A selectable where the content should be inserted. If not specified, the current
- * {@link module:engine/model/document~Document#selection document selection} will be used instead.
- * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
- * @param options Additional options.
- * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
- * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).
- * * When `'auto'`, the algorithm will decide whether to insert the object before or after `selectable` to avoid content splitting.
- * * When `'before'`, the closest position before `selectable` will be used that will not result in content splitting.
- * * When `'after'`, the closest position after `selectable` will be used that will not result in content splitting.
- *
- * Note that this option works only for block objects. Inline objects are inserted into text and do not split blocks.
- * @param options.setSelection An option that, when set, moves the
- * {@link module:engine/model/document~Document#selection document selection} after inserting the object.
- * * When `'on'`, the document selection will be set on the inserted object.
- * * When `'after'`, the document selection will move to the closest text node after the inserted object. If there is no
- * such text node, a paragraph will be created and the document selection will be moved inside it.
- * @returns A range which contains all the performed changes. This is a range that, if removed,
- * would return the model to the state before the insertion. If no changes were preformed by `insertObject()`, returns a range collapsed
- * at the insertion position.
- */
-export default function insertObject(model, object, selectable, options = {}) {
-    if (!model.schema.isObject(object)) {
-        /**
-         * Tried to insert an element with {@link module:engine/model/utils/insertobject insertObject()} function
-         * that is not defined as an object in schema.
-         * See {@link module:engine/model/schema~SchemaItemDefinition#isObject `SchemaItemDefinition`}.
-         * If you want to insert content that is not an object you might want to use
-         * {@link module:engine/model/utils/insertcontent insertContent()} function.
-         * @error insertobject-element-not-an-object
-         */
-        throw new CKEditorError('insertobject-element-not-an-object', model, { object });
-    }
-    // Normalize selectable to a selection instance.
-    const originalSelection = selectable ? selectable : model.document.selection;
-    // Adjust the insertion selection.
-    let insertionSelection = originalSelection;
-    if (options.findOptimalPosition && model.schema.isBlock(object)) {
-        insertionSelection = model.createSelection(findOptimalInsertionRange(originalSelection, model, options.findOptimalPosition));
-    }
-    // Collect attributes to be copied on the inserted object.
-    const firstSelectedBlock = first(originalSelection.getSelectedBlocks());
-    const attributesToCopy = {};
-    if (firstSelectedBlock) {
-        Object.assign(attributesToCopy, model.schema.getAttributesWithProperty(firstSelectedBlock, 'copyOnReplace', true));
-    }
-    return model.change(writer => {
-        // Remove the selected content to find out what the parent of the inserted object would be.
-        // It would be removed inside model.insertContent() anyway.
-        if (!insertionSelection.isCollapsed) {
-            model.deleteContent(insertionSelection, { doNotAutoparagraph: true });
-        }
-        let elementToInsert = object;
-        const insertionPositionParent = insertionSelection.anchor.parent;
-        // Autoparagraphing of an inline objects.
-        if (!model.schema.checkChild(insertionPositionParent, object) &&
-            model.schema.checkChild(insertionPositionParent, 'paragraph') &&
-            model.schema.checkChild('paragraph', object)) {
-            elementToInsert = writer.createElement('paragraph');
-            writer.insert(object, elementToInsert);
-        }
-        // Apply attributes that are allowed on the inserted object (or paragraph if autoparagraphed).
-        model.schema.setAllowedAttributes(elementToInsert, attributesToCopy, writer);
-        // Insert the prepared content at the optionally adjusted selection.
-        const affectedRange = model.insertContent(elementToInsert, insertionSelection);
-        // Nothing got inserted.
-        if (affectedRange.isCollapsed) {
-            return affectedRange;
-        }
-        if (options.setSelection) {
-            updateSelection(writer, object, options.setSelection, attributesToCopy);
-        }
-        return affectedRange;
-    });
-}
-/**
- * Updates document selection based on given `place` parameter in relation to `contextElement` element.
- *
- * @param writer An instance of the model writer.
- * @param contextElement An element to set the attributes on.
- * @param place The place where selection should be set in relation to the `contextElement` element.
- * Value `on` will set selection on the passed `contextElement`. Value `after` will set selection after `contextElement`.
- * @param attributes Attributes keys and values to set on a paragraph that this function can create when
- * `place` parameter is equal to `after` but there is no element with `$text` node to set selection in.
- */
-function updateSelection(writer, contextElement, place, paragraphAttributes) {
-    const model = writer.model;
-    if (place == 'on') {
-        writer.setSelection(contextElement, 'on');
-        return;
-    }
-    if (place != 'after') {
-        /**
-         * The unsupported `options.setSelection` parameter was passed
-         * to the {@link module:engine/model/utils/insertobject insertObject()} function.
-         * Check the {@link module:engine/model/utils/insertobject insertObject()} API documentation for allowed
-         * `options.setSelection` parameter values.
-         *
-         * @error insertobject-invalid-place-parameter-value
-         */
-        throw new CKEditorError('insertobject-invalid-place-parameter-value', model);
-    }
-    let nextElement = contextElement.nextSibling;
-    if (model.schema.isInline(contextElement)) {
-        writer.setSelection(contextElement, 'after');
-        return;
-    }
-    // Check whether an element next to the inserted element is defined and can contain a text.
-    const canSetSelection = nextElement && model.schema.checkChild(nextElement, '$text');
-    // If the element is missing, but a paragraph could be inserted next to the element, let's add it.
-    if (!canSetSelection && model.schema.checkChild(contextElement.parent, 'paragraph')) {
-        nextElement = writer.createElement('paragraph');
-        model.schema.setAllowedAttributes(nextElement, paragraphAttributes, writer);
-        model.insertContent(nextElement, writer.createPositionAfter(contextElement));
-    }
-    // Put the selection inside the element, at the beginning.
-    if (nextElement) {
-        writer.setSelection(nextElement, 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/insertobject
+ */
+import { findOptimalInsertionRange } from './findoptimalinsertionrange';
+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.
+ *
+ * **Note:** Use {@link module:engine/model/model~Model#insertObject} instead of this function.
+ * This function is only exposed to be reusable in algorithms which change the {@link module:engine/model/model~Model#insertObject}
+ * method's behavior.
+ *
+ * **Note**: For more documentation and examples, see {@link module:engine/model/model~Model#insertObject}.
+ *
+ * @param model The model in context of which the insertion should be performed.
+ * @param object An object to be inserted into the model document.
+ * @param selectable A selectable where the content should be inserted. If not specified, the current
+ * {@link module:engine/model/document~Document#selection document selection} will be used instead.
+ * @param placeOrOffset Specifies the exact place or offset for the insertion to take place, relative to `selectable`.
+ * @param options Additional options.
+ * @param options.findOptimalPosition An option that, when set, adjusts the insertion position (relative to
+ * `selectable` and `placeOrOffset`) so that the content of `selectable` is not split upon insertion (a.k.a. non-destructive insertion).
+ * * When `'auto'`, the algorithm will decide whether to insert the object before or after `selectable` to avoid content splitting.
+ * * When `'before'`, the closest position before `selectable` will be used that will not result in content splitting.
+ * * When `'after'`, the closest position after `selectable` will be used that will not result in content splitting.
+ *
+ * Note that this option works only for block objects. Inline objects are inserted into text and do not split blocks.
+ * @param options.setSelection An option that, when set, moves the
+ * {@link module:engine/model/document~Document#selection document selection} after inserting the object.
+ * * When `'on'`, the document selection will be set on the inserted object.
+ * * When `'after'`, the document selection will move to the closest text node after the inserted object. If there is no
+ * such text node, a paragraph will be created and the document selection will be moved inside it.
+ * @returns A range which contains all the performed changes. This is a range that, if removed,
+ * would return the model to the state before the insertion. If no changes were preformed by `insertObject()`, returns a range collapsed
+ * at the insertion position.
+ */
+export default function insertObject(model, object, selectable, options = {}) {
+    if (!model.schema.isObject(object)) {
+        /**
+         * Tried to insert an element with {@link module:engine/model/utils/insertobject insertObject()} function
+         * that is not defined as an object in schema.
+         * See {@link module:engine/model/schema~SchemaItemDefinition#isObject `SchemaItemDefinition`}.
+         * If you want to insert content that is not an object you might want to use
+         * {@link module:engine/model/utils/insertcontent insertContent()} function.
+         * @error insertobject-element-not-an-object
+         */
+        throw new CKEditorError('insertobject-element-not-an-object', model, { object });
+    }
+    // Normalize selectable to a selection instance.
+    const originalSelection = selectable ? selectable : model.document.selection;
+    // Adjust the insertion selection.
+    let insertionSelection = originalSelection;
+    if (options.findOptimalPosition && model.schema.isBlock(object)) {
+        insertionSelection = model.createSelection(findOptimalInsertionRange(originalSelection, model, options.findOptimalPosition));
+    }
+    // Collect attributes to be copied on the inserted object.
+    const firstSelectedBlock = first(originalSelection.getSelectedBlocks());
+    const attributesToCopy = {};
+    if (firstSelectedBlock) {
+        Object.assign(attributesToCopy, model.schema.getAttributesWithProperty(firstSelectedBlock, 'copyOnReplace', true));
+    }
+    return model.change(writer => {
+        // Remove the selected content to find out what the parent of the inserted object would be.
+        // It would be removed inside model.insertContent() anyway.
+        if (!insertionSelection.isCollapsed) {
+            model.deleteContent(insertionSelection, { doNotAutoparagraph: true });
+        }
+        let elementToInsert = object;
+        const insertionPositionParent = insertionSelection.anchor.parent;
+        // Autoparagraphing of an inline objects.
+        if (!model.schema.checkChild(insertionPositionParent, object) &&
+            model.schema.checkChild(insertionPositionParent, 'paragraph') &&
+            model.schema.checkChild('paragraph', object)) {
+            elementToInsert = writer.createElement('paragraph');
+            writer.insert(object, elementToInsert);
+        }
+        // Apply attributes that are allowed on the inserted object (or paragraph if autoparagraphed).
+        model.schema.setAllowedAttributes(elementToInsert, attributesToCopy, writer);
+        // Insert the prepared content at the optionally adjusted selection.
+        const affectedRange = model.insertContent(elementToInsert, insertionSelection);
+        // Nothing got inserted.
+        if (affectedRange.isCollapsed) {
+            return affectedRange;
+        }
+        if (options.setSelection) {
+            updateSelection(writer, object, options.setSelection, attributesToCopy);
+        }
+        return affectedRange;
+    });
+}
+/**
+ * Updates document selection based on given `place` parameter in relation to `contextElement` element.
+ *
+ * @param writer An instance of the model writer.
+ * @param contextElement An element to set the attributes on.
+ * @param place The place where selection should be set in relation to the `contextElement` element.
+ * Value `on` will set selection on the passed `contextElement`. Value `after` will set selection after `contextElement`.
+ * @param attributes Attributes keys and values to set on a paragraph that this function can create when
+ * `place` parameter is equal to `after` but there is no element with `$text` node to set selection in.
+ */
+function updateSelection(writer, contextElement, place, paragraphAttributes) {
+    const model = writer.model;
+    if (place == 'on') {
+        writer.setSelection(contextElement, 'on');
+        return;
+    }
+    if (place != 'after') {
+        /**
+         * The unsupported `options.setSelection` parameter was passed
+         * to the {@link module:engine/model/utils/insertobject insertObject()} function.
+         * Check the {@link module:engine/model/utils/insertobject insertObject()} API documentation for allowed
+         * `options.setSelection` parameter values.
+         *
+         * @error insertobject-invalid-place-parameter-value
+         */
+        throw new CKEditorError('insertobject-invalid-place-parameter-value', model);
+    }
+    let nextElement = contextElement.nextSibling;
+    if (model.schema.isInline(contextElement)) {
+        writer.setSelection(contextElement, 'after');
+        return;
+    }
+    // Check whether an element next to the inserted element is defined and can contain a text.
+    const canSetSelection = nextElement && model.schema.checkChild(nextElement, '$text');
+    // If the element is missing, but a paragraph could be inserted next to the element, let's add it.
+    if (!canSetSelection && model.schema.checkChild(contextElement.parent, 'paragraph')) {
+        nextElement = writer.createElement('paragraph');
+        model.schema.setAllowedAttributes(nextElement, paragraphAttributes, writer);
+        model.insertContent(nextElement, writer.createPositionAfter(contextElement));
+    }
+    // Put the selection inside the element, at the beginning.
+    if (nextElement) {
+        writer.setSelection(nextElement, 0);
+    }
+}

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

@@ -1,48 +1,48 @@
-/**
- * @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/modifyselection
- */
-import DocumentSelection from '../documentselection';
-import type Model from '../model';
-import type Selection from '../selection';
-/**
- * Modifies the selection. Currently, the supported modifications are:
- *
- * * Extending. The selection focus is moved in the specified `options.direction` with a step specified in `options.unit`.
- * Possible values for `unit` are:
- *  * `'character'` (default) - moves selection by one user-perceived character. In most cases this means moving by one
- *  character in `String` sense. However, unicode also defines "combing marks". These are special symbols, that combines
- *  with a symbol before it ("base character") to create one user-perceived character. For example, `q̣̇` is a normal
- *  letter `q` with two "combining marks": upper dot (`Ux0307`) and lower dot (`Ux0323`). For most actions, i.e. extending
- *  selection by one position, it is correct to include both "base character" and all of it's "combining marks". That is
- *  why `'character'` value is most natural and common method of modifying selection.
- *  * `'codePoint'` - moves selection by one unicode code point. In contrary to, `'character'` unit, this will insert
- *  selection between "base character" and "combining mark", because "combining marks" have their own unicode code points.
- *  However, for technical reasons, unicode code points with values above `UxFFFF` are represented in native `String` by
- *  two characters, called "surrogate pairs". Halves of "surrogate pairs" have a meaning only when placed next to each other.
- *  For example `𨭎` is represented in `String` by `\uD862\uDF4E`. Both `\uD862` and `\uDF4E` do not have any meaning
- *  outside the pair (are rendered as ? when alone). Position between them would be incorrect. In this case, selection
- *  extension will include whole "surrogate pair".
- *  * `'word'` - moves selection by a whole word.
- *
- * **Note:** if you extend a forward selection in a backward direction you will in fact shrink it.
- *
- * **Note:** Use {@link module:engine/model/model~Model#modifySelection} instead of this function.
- * This function is only exposed to be reusable in algorithms
- * which change the {@link module:engine/model/model~Model#modifySelection}
- * method's behavior.
- *
- * @param model The model in context of which the selection modification should be performed.
- * @param selection The selection to modify.
- * @param options.direction The direction in which the selection should be modified. Default 'forward'.
- * @param options.unit The unit by which selection should be modified. Default 'character'.
- * @param options.treatEmojiAsSingleUnit Whether multi-characer emoji sequences should be handled as single unit.
- */
-export default function modifySelection(model: Model, selection: Selection | DocumentSelection, options?: {
-    direction?: 'forward' | 'backward';
-    unit?: 'character' | 'codePoint' | 'word';
-    treatEmojiAsSingleUnit?: 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/modifyselection
+ */
+import DocumentSelection from '../documentselection';
+import type Model from '../model';
+import type Selection from '../selection';
+/**
+ * Modifies the selection. Currently, the supported modifications are:
+ *
+ * * Extending. The selection focus is moved in the specified `options.direction` with a step specified in `options.unit`.
+ * Possible values for `unit` are:
+ *  * `'character'` (default) - moves selection by one user-perceived character. In most cases this means moving by one
+ *  character in `String` sense. However, unicode also defines "combing marks". These are special symbols, that combines
+ *  with a symbol before it ("base character") to create one user-perceived character. For example, `q̣̇` is a normal
+ *  letter `q` with two "combining marks": upper dot (`Ux0307`) and lower dot (`Ux0323`). For most actions, i.e. extending
+ *  selection by one position, it is correct to include both "base character" and all of it's "combining marks". That is
+ *  why `'character'` value is most natural and common method of modifying selection.
+ *  * `'codePoint'` - moves selection by one unicode code point. In contrary to, `'character'` unit, this will insert
+ *  selection between "base character" and "combining mark", because "combining marks" have their own unicode code points.
+ *  However, for technical reasons, unicode code points with values above `UxFFFF` are represented in native `String` by
+ *  two characters, called "surrogate pairs". Halves of "surrogate pairs" have a meaning only when placed next to each other.
+ *  For example `𨭎` is represented in `String` by `\uD862\uDF4E`. Both `\uD862` and `\uDF4E` do not have any meaning
+ *  outside the pair (are rendered as ? when alone). Position between them would be incorrect. In this case, selection
+ *  extension will include whole "surrogate pair".
+ *  * `'word'` - moves selection by a whole word.
+ *
+ * **Note:** if you extend a forward selection in a backward direction you will in fact shrink it.
+ *
+ * **Note:** Use {@link module:engine/model/model~Model#modifySelection} instead of this function.
+ * This function is only exposed to be reusable in algorithms
+ * which change the {@link module:engine/model/model~Model#modifySelection}
+ * method's behavior.
+ *
+ * @param model The model in context of which the selection modification should be performed.
+ * @param selection The selection to modify.
+ * @param options.direction The direction in which the selection should be modified. Default 'forward'.
+ * @param options.unit The unit by which selection should be modified. Default 'character'.
+ * @param options.treatEmojiAsSingleUnit Whether multi-characer emoji sequences should be handled as single unit.
+ */
+export default function modifySelection(model: Model, selection: Selection | DocumentSelection, options?: {
+    direction?: 'forward' | 'backward';
+    unit?: 'character' | 'codePoint' | 'word';
+    treatEmojiAsSingleUnit?: boolean;
+}): void;