@ckeditor/ckeditor5-typing 41.3.0-alpha.4 → 41.3.0

package/dist/types/twostepcaretmovement.d.ts

@@ -1,236 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/twostepcaretmovement
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-/**
- * This plugin enables the two-step caret (phantom) movement behavior for
- * {@link module:typing/twostepcaretmovement~TwoStepCaretMovement#registerAttribute registered attributes}
- * on arrow right (<kbd>→</kbd>) and left (<kbd>←</kbd>) key press.
- *
- * Thanks to this (phantom) caret movement the user is able to type before/after as well as at the
- * beginning/end of an attribute.
- *
- * **Note:** This plugin support right–to–left (Arabic, Hebrew, etc.) content by mirroring its behavior
- * but for the sake of simplicity examples showcase only left–to–right use–cases.
- *
- * # Forward movement
- *
- * ## "Entering" an attribute:
- *
- * When this plugin is enabled and registered for the `a` attribute and the selection is right before it
- * (at the attribute boundary), pressing the right arrow key will not move the selection but update its
- * attributes accordingly:
- *
- * * When enabled:
- *
- * ```xml
- * foo{}<$text a="true">bar</$text>
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * foo<$text a="true">{}bar</$text>
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * foo{}<$text a="true">bar</$text>
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * foo<$text a="true">b{}ar</$text>
- * ```
- *
- *
- * ## "Leaving" an attribute:
- *
- * * When enabled:
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * <$text a="true">bar</$text>b{}az
- * ```
- *
- * # Backward movement
- *
- * * When enabled:
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">ba{}r</$text>b{}az
- * ```
- *
- * # Multiple attributes
- *
- * * When enabled and many attributes starts or ends at the same position:
- *
- * ```xml
- * <$text a="true" b="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true" b="true">bar{}</$text>baz
- * ```
- *
- * * When enabled and one procedes another:
- *
- * ```xml
- * <$text a="true">bar</$text><$text b="true">{}bar</$text>
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">bar{}</$text><$text b="true">bar</$text>
- * ```
- *
- */
-export default class TwoStepCaretMovement extends Plugin {
-    /**
-     * A set of attributes to handle.
-     */
-    private attributes;
-    /**
-     * The current UID of the overridden gravity, as returned by
-     * {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
-     */
-    private _overrideUid;
-    /**
-     * A flag indicating that the automatic gravity restoration should not happen upon the next
-     * gravity restoration.
-     * {@link module:engine/model/selection~Selection#event:change:range} event.
-     */
-    private _isNextGravityRestorationSkipped;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TwoStepCaretMovement";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Registers a given attribute for the two-step caret movement.
-     *
-     * @param attribute Name of the attribute to handle.
-     */
-    registerAttribute(attribute: string): void;
-    /**
-     * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
-     *
-     * @param data Data of the key press.
-     * @returns `true` when the handler prevented caret movement.
-     */
-    private _handleForwardMovement;
-    /**
-     * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~View}.
-     *
-     * @param data Data of the key press.
-     * @returns `true` when the handler prevented caret movement
-     */
-    private _handleBackwardMovement;
-    /**
-     * Starts listening to {@link module:engine/view/document~Document#event:mousedown} and
-     * {@link module:engine/view/document~Document#event:selectionChange} and puts the selection before/after a 2-step node
-     * if clicked at the beginning/ending of the 2-step node.
-     *
-     * The purpose of this action is to allow typing around the 2-step node directly after a click.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/1016.
-     */
-    private _enableClickingAfterNode;
-    /**
-     * Starts listening to {@link module:engine/model/model~Model#event:insertContent} and corrects the model
-     * selection attributes if the selection is at the end of a two-step node after inserting the content.
-     *
-     * The purpose of this action is to improve the overall UX because the user is no longer "trapped" by the
-     * two-step attribute of the selection, and they can type a "clean" (`linkHref`–less) text right away.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/6053.
-     */
-    private _enableInsertContentSelectionAttributesFixer;
-    /**
-     * Starts listening to {@link module:engine/model/model~Model#deleteContent} and checks whether
-     * removing a content right after the tow-step attribute.
-     *
-     * If so, the selection should not preserve the two-step attribute. However, if
-     * the {@link module:typing/twostepcaretmovement~TwoStepCaretMovement} plugin is active and
-     * the selection has the two-step attribute due to overridden gravity (at the end), the two-step attribute should stay untouched.
-     *
-     * The purpose of this action is to allow removing the link text and keep the selection outside the link.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/7521.
-     */
-    private _handleDeleteContentAfterNode;
-    /**
-     * `true` when the gravity is overridden for the plugin.
-     */
-    private get _isGravityOverridden();
-    /**
-     * Overrides the gravity using the {@link module:engine/model/writer~Writer model writer}
-     * and stores the information about this fact in the {@link #_overrideUid}.
-     *
-     * A shorthand for {@link module:engine/model/writer~Writer#overrideSelectionGravity}.
-     */
-    private _overrideGravity;
-    /**
-     * Restores the gravity using the {@link module:engine/model/writer~Writer model writer}.
-     *
-     * A shorthand for {@link module:engine/model/writer~Writer#restoreSelectionGravity}.
-     */
-    private _restoreGravity;
-}

package/dist/types/typing.d.ts

@@ -1,27 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/typing
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import Input from './input.js';
-import Delete from './delete.js';
-/**
- * The typing feature. It handles typing.
- *
- * This is a "glue" plugin which loads the {@link module:typing/input~Input} and {@link module:typing/delete~Delete}
- * plugins.
- */
-export default class Typing extends Plugin {
-    static get requires(): readonly [typeof Input, typeof Delete];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Typing";
-}

package/dist/types/typingconfig.d.ts

@@ -1,208 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/typingconfig
- */
-/**
- * The configuration of the typing features. Used by the typing features in `@ckeditor/ckeditor5-typing` package.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		typing: ... // Typing feature options.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface TypingConfig {
-    /**
-     * The granularity of undo/redo for typing and deleting. The value `20` means (more or less) that a new undo step
-     * is created every 20 characters are inserted or deleted.
-     *
-     * @default 20
-     */
-    undoStep?: number;
-    /**
-     * The configuration of the {@link module:typing/texttransformation~TextTransformation} feature.
-     *
-     * Read more in {@link module:typing/typingconfig~TextTransformationConfig}.
-     */
-    transformations: TextTransformationConfig;
-}
-/**
- * The configuration of the text transformation feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		typing: {
- * 			transformations: ... // Text transformation feature options.
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * By default, the feature comes pre-configured
- * (via {@link module:typing/typingconfig~TextTransformationConfig#include `config.typing.transformations.include`}) with the
- * following groups of transformations:
- *
- * * Typography (group name: `typography`)
- *   - `ellipsis`: transforms `...` to `…`
- *   - `enDash`: transforms ` -- ` to ` – `
- *   - `emDash`: transforms ` --- ` to ` — `
- * * Quotations (group name: `quotes`)
- *   - `quotesPrimary`: transforms `"Foo bar"` to `“Foo bar”`
- *   - `quotesSecondary`: transforms `'Foo bar'` to `‘Foo bar’`
- * * Symbols (group name: `symbols`)
- *   - `trademark`: transforms `(tm)` to `™`
- *   - `registeredTrademark`: transforms `(r)` to `®`
- *   - `copyright`: transforms `(c)` to `©`
- * * Mathematical (group name: `mathematical`)
- *   - `oneHalf`: transforms `1/2` to: `½`
- *   - `oneThird`: transforms `1/3` to: `⅓`
- *   - `twoThirds`: transforms `2/3` to: `⅔`
- *   - `oneForth`: transforms `1/4` to: `¼`
- *   - `threeQuarters`: transforms `3/4` to: `¾`
- *   - `lessThanOrEqual`: transforms `<=` to: `≤`
- *   - `greaterThanOrEqual`: transforms `>=` to: `≥`
- *   - `notEqual`: transforms `!=` to: `≠`
- *   - `arrowLeft`: transforms `<-` to: `←`
- *   - `arrowRight`: transforms `->` to: `→`
- * * Misc:
- *   - `quotesPrimaryEnGb`: transforms `'Foo bar'` to `‘Foo bar’`
- *   - `quotesSecondaryEnGb`: transforms `"Foo bar"` to `“Foo bar”`
- *   - `quotesPrimaryPl`: transforms `"Foo bar"` to `„Foo bar”`
- *   - `quotesSecondaryPl`:  transforms `'Foo bar'` to `‚Foo bar’`
- *
- * In order to load additional transformations, use the
- * {@link module:typing/typingconfig~TextTransformationConfig#extra `transformations.extra` option}.
- *
- * In order to narrow down the list of transformations, use the
- * {@link module:typing/typingconfig~TextTransformationConfig#remove `transformations.remove` option}.
- *
- * In order to completely override the supported transformations, use the
- * {@link module:typing/typingconfig~TextTransformationConfig#include `transformations.include` option}.
- *
- * Examples:
- *
- * ```ts
- * const transformationsConfig = {
- * 	include: [
- * 		// Use only the 'quotes' and 'typography' groups.
- * 		'quotes',
- * 		'typography',
- *
- * 		// Plus, some custom transformation.
- * 		{ from: 'CKE', to: 'CKEditor' }
- * 	]
- * };
- *
- * const transformationsConfig = {
- * 	// Remove the 'ellipsis' transformation loaded by the 'typography' group.
- * 	remove: [ 'ellipsis' ]
- * }
- * ```
- */
-export interface TextTransformationConfig {
-    /**
-     * The standard list of text transformations supported by the editor. By default it comes pre-configured with a couple dozen of them
-     * (see {@link module:typing/typingconfig~TextTransformationConfig} for the full list). You can override this list completely
-     * by setting this option or use the other two options
-     * ({@link module:typing/typingconfig~TextTransformationConfig#extra `transformations.extra`},
-     * {@link module:typing/typingconfig~TextTransformationConfig#remove `transformations.remove`}) to fine-tune the default list.
-     */
-    include: Array<TextTransformationDescription | string>;
-    /**
-     * Additional text transformations that are added to the transformations defined in
-     * {@link module:typing/typingconfig~TextTransformationConfig#include `transformations.include`}.
-     *
-     * ```ts
-     * const transformationsConfig = {
-     * 	extra: [
-     * 		{ from: 'CKE', to: 'CKEditor' }
-     * 	]
-     * };
-     * ```
-     */
-    extra?: Array<TextTransformationDescription | string>;
-    /**
-     * The text transformation names that are removed from transformations defined in
-     * {@link module:typing/typingconfig~TextTransformationConfig#include `transformations.include`} or
-     * {@link module:typing/typingconfig~TextTransformationConfig#extra `transformations.extra`}.
-     *
-     * ```ts
-     * const transformationsConfig = {
-     * 	remove: [
-     * 		'ellipsis',    // Remove only 'ellipsis' from the 'typography' group.
-     * 		'mathematical' // Remove all transformations from the 'mathematical' group.
-     * 	]
-     * }
-     * ```
-     */
-    remove?: Array<TextTransformationDescription | string>;
-}
-/**
- * The text transformation definition object. It describes what should be replaced with what.
- *
- * The input value (`from`) can be passed either as a string or as a regular expression.
- *
- * * If a string is passed, it will be simply checked if the end of the input matches it.
- * * If a regular expression is passed, its entire length must be covered with capturing groups (e.g. `/(foo)(bar)$/`).
- * Also, since it is compared against the end of the input, it has to end with  `$` to be correctly matched.
- * See examples below.
- *
- * The output value (`to`) can be passed as a string, as an array or as a function.
- *
- * * If a string is passed, it will be used as a replacement value as-is. Note that a string output value can be used only if
- * the input value is a string, too.
- * * If an array is passed, it has to have the same number of elements as there are capturing groups in the input value regular expression.
- * Each capture group will be replaced with a corresponding string from the passed array. If a given capturing group should not be replaced,
- * use `null` instead of passing a string.
- * * If a function is used, it should return an array as described above. The function is passed one parameter &ndash; an array with matches
- * by the regular expression. See the examples below.
- *
- * A simple string-to-string replacement:
- *
- * ```ts
- * { from: '(c)', to: '©' }
- * ```
- *
- * Change quote styles using a regular expression. Note how all the parts are in separate capturing groups and the space at the beginning
- * and the text inside quotes are not replaced (`null` passed as the first and the third value in the `to` parameter):
- *
- * ```ts
- * {
- * 	from: /(^|\s)(")([^"]*)(")$/,
- * 	to: [ null, '“', null, '”' ]
- * }
- * ```
- *
- * Automatic uppercase after a dot using a callback:
- *
- * ```ts
- * {
- * 	from: /(\. )([a-z])$/,
- * 	to: matches => [ null, matches[ 1 ].toUpperCase() ]
- * }
- * ```
- */
-export interface TextTransformationDescription {
-    /**
-     * The string or regular expression to transform.
-     */
-    from: string | RegExp;
-    /**
-     * The text to transform compatible with `String.replace()`.
-     */
-    to: string | Array<string | null> | ((matches: Array<string>) => Array<string | null>);
-}

package/dist/types/utils/changebuffer.d.ts

@@ -1,107 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/utils/changebuffer
- */
-import type { Model, Batch } from '@ckeditor/ckeditor5-engine';
-/**
- * Change buffer allows to group atomic changes (like characters that have been typed) into
- * {@link module:engine/model/batch~Batch batches}.
- *
- * Batches represent single undo steps, hence changes added to one single batch are undone together.
- *
- * The buffer has a configurable limit of atomic changes that it can accommodate. After the limit was
- * exceeded (see {@link ~ChangeBuffer#input}), a new batch is created in {@link ~ChangeBuffer#batch}.
- *
- * To use the change buffer you need to let it know about the number of changes that were added to the batch:
- *
- * ```ts
- * const buffer = new ChangeBuffer( model, LIMIT );
- *
- * // Later on in your feature:
- * buffer.batch.insert( pos, insertedCharacters );
- * buffer.input( insertedCharacters.length );
- * ```
- */
-export default class ChangeBuffer {
-    /**
-     * The model instance.
-     */
-    readonly model: Model;
-    /**
-     * The maximum number of atomic changes which can be contained in one batch.
-     */
-    readonly limit: number;
-    /**
-     * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
-     */
-    private _isLocked;
-    /**
-     * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
-     * the {@link #batch batch} is set to a new one.
-     */
-    private _size;
-    /**
-     * The current batch instance.
-     */
-    private _batch;
-    /**
-     * The callback to document the change event which later needs to be removed.
-     */
-    private readonly _changeCallback;
-    /**
-     * The callback to document selection `change:attribute` and `change:range` events which resets the buffer.
-     */
-    private readonly _selectionChangeCallback;
-    /**
-     * Creates a new instance of the change buffer.
-     *
-     * @param limit The maximum number of atomic changes which can be contained in one batch.
-     */
-    constructor(model: Model, limit?: number);
-    /**
-     * The current batch to which a feature should add its operations. Once the {@link #size}
-     * is reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-     */
-    get batch(): Batch;
-    /**
-     * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
-     * the {@link #batch batch} is set to a new one.
-     */
-    get size(): number;
-    /**
-     * The input number of changes into the buffer. Once the {@link #size} is
-     * reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-     *
-     * @param changeCount The number of atomic changes to input.
-     */
-    input(changeCount: number): void;
-    /**
-     * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
-     */
-    get isLocked(): boolean;
-    /**
-     * Locks the buffer.
-     */
-    lock(): void;
-    /**
-     * Unlocks the buffer.
-     */
-    unlock(): void;
-    /**
-     * Destroys the buffer.
-     */
-    destroy(): void;
-    /**
-     * Resets the change buffer.
-     *
-     * @param ignoreLock Whether internal lock {@link #isLocked} should be ignored.
-     */
-    private _reset;
-}

package/dist/types/utils/findattributerange.d.ts

@@ -1,37 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/utils/findattributerange
- */
-import type { Position, Model, Range } from '@ckeditor/ckeditor5-engine';
-/**
- * Returns a model range that covers all consecutive nodes with the same `attributeName` and its `value`
- * that intersect the given `position`.
- *
- * It can be used e.g. to get the entire range on which the `linkHref` attribute needs to be changed when having a
- * selection inside a link.
- *
- * @param position The start position.
- * @param attributeName The attribute name.
- * @param value The attribute value.
- * @param model The model instance.
- * @returns The link range.
- */
-export default function findAttributeRange(position: Position, attributeName: string, value: unknown, model: Model): Range;
-/**
- * Walks forward or backward (depends on the `lookBack` flag), node by node, as long as they have the same attribute value
- * and returns a position just before or after (depends on the `lookBack` flag) the last matched node.
- *
- * @param position The start position.
- * @param attributeName The attribute name.
- * @param value The attribute value.
- * @param lookBack Whether the walk direction is forward (`false`) or backward (`true`).
- * @returns The position just before the last matched node.
- */
-export declare function findAttributeRangeBound(position: Position, attributeName: string, value: unknown, lookBack: boolean, model: Model): Position;

package/dist/types/utils/getlasttextline.d.ts

@@ -1,53 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/utils/getlasttextline
- */
-import type { Model, Range } from '@ckeditor/ckeditor5-engine';
-/**
- * Returns the last text line from the given range.
- *
- * "The last text line" is understood as text (from one or more text nodes) which is limited either by a parent block
- * or by inline elements (e.g. `<softBreak>`).
- *
- * ```ts
- * const rangeToCheck = model.createRange(
- * 	model.createPositionAt( paragraph, 0 ),
- * 	model.createPositionAt( paragraph, 'end' )
- * );
- *
- * const { text, range } = getLastTextLine( rangeToCheck, model );
- * ```
- *
- * For model below, the returned `text` will be "Foo bar baz" and `range` will be set on whole `<paragraph>` content:
- *
- * ```xml
- * <paragraph>Foo bar baz<paragraph>
- * ```
- *
- * However, in below case, `text` will be set to "baz" and `range` will be set only on "baz".
- *
- * ```xml
- * <paragraph>Foo<softBreak></softBreak>bar<softBreak></softBreak>baz<paragraph>
- * ```
- */
-export default function getLastTextLine(range: Range, model: Model): LastTextLineData;
-/**
- * The value returned by {@link module:typing/utils/getlasttextline~getLastTextLine}.
- */
-export type LastTextLineData = {
-    /**
-     * The text from the text nodes in the last text line.
-     */
-    text: string;
-    /**
-     * The range set on the text nodes in the last text line.
-     */
-    range: Range;
-};