@ckeditor/ckeditor5-list 36.0.0 → 37.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-list",
-  "version": "36.0.0",
+  "version": "37.0.0-alpha.0",
   "description": "Ordered and unordered lists feature to CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,44 +12,44 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.0",
-    "@ckeditor/ckeditor5-ui": "^36.0.0"
+    "ckeditor5": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-alignment": "^36.0.0",
-    "@ckeditor/ckeditor5-autoformat": "^36.0.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-code-block": "^36.0.0",
-    "@ckeditor/ckeditor5-core": "^36.0.0",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-easy-image": "^36.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
-    "@ckeditor/ckeditor5-engine": "^36.0.0",
-    "@ckeditor/ckeditor5-enter": "^36.0.0",
-    "@ckeditor/ckeditor5-essentials": "^36.0.0",
-    "@ckeditor/ckeditor5-font": "^36.0.0",
-    "@ckeditor/ckeditor5-heading": "^36.0.0",
-    "@ckeditor/ckeditor5-highlight": "^36.0.0",
-    "@ckeditor/ckeditor5-horizontal-line": "^36.0.0",
-    "@ckeditor/ckeditor5-html-embed": "^36.0.0",
-    "@ckeditor/ckeditor5-html-support": "^36.0.0",
-    "@ckeditor/ckeditor5-image": "^36.0.0",
-    "@ckeditor/ckeditor5-indent": "^36.0.0",
-    "@ckeditor/ckeditor5-link": "^36.0.0",
-    "@ckeditor/ckeditor5-media-embed": "^36.0.0",
-    "@ckeditor/ckeditor5-page-break": "^36.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
-    "@ckeditor/ckeditor5-remove-format": "^36.0.0",
-    "@ckeditor/ckeditor5-source-editing": "^36.0.0",
-    "@ckeditor/ckeditor5-table": "^36.0.0",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.0",
-    "@ckeditor/ckeditor5-typing": "^36.0.0",
-    "@ckeditor/ckeditor5-undo": "^36.0.0",
-    "@ckeditor/ckeditor5-utils": "^36.0.0",
-    "@ckeditor/ckeditor5-widget": "^36.0.0",
+    "@ckeditor/ckeditor5-alignment": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-autoformat": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-cloud-services": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-code-block": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-easy-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-font": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-highlight": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-horizontal-line": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-html-embed": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-html-support": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-indent": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-media-embed": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-page-break": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-remove-format": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-source-editing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-widget": "^37.0.0-alpha.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -80,5 +80,6 @@
     "dll:build": "webpack",
     "build": "tsc -p ./tsconfig.release.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/documentlist/converters.d.ts

@@ -0,0 +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 list/documentlist/converters
+ */
+import { type DowncastAttributeEvent, type EditingController, type Element, type ElementCreatorFunction, type Mapper, type Model, type UpcastElementEvent, type ViewElement } from 'ckeditor5/src/engine';
+import type { GetCallback } from 'ckeditor5/src/utils';
+import { type ListElement } from './utils/model';
+import type { default as DocumentListEditing, DowncastStrategy } from './documentlistediting';
+/**
+ * Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.
+ *
+ * @internal
+ */
+export declare function listItemUpcastConverter(): GetCallback<UpcastElementEvent>;
+/**
+ * Returns the upcast converter for the `<ul>` and `<ol>` view elements that cleans the input view of garbage.
+ * This is mostly to clean whitespaces from between the `<li>` view elements inside the view list element. However,
+ * incorrect data can also be cleared if the view was incorrect.
+ *
+ * @internal
+ */
+export declare function listUpcastCleanList(): GetCallback<UpcastElementEvent>;
+/**
+ * Returns a model document change:data event listener that triggers conversion of related items if needed.
+ *
+ * @internal
+ * @param model The editor model.
+ * @param editing The editing controller.
+ * @param attributeNames The list of all model list attributes (including registered strategies).
+ * @param documentListEditing The document list editing plugin.
+ */
+export declare function reconvertItemsOnDataChange(model: Model, editing: EditingController, attributeNames: Array<string>, documentListEditing: DocumentListEditing): () => void;
+/**
+ * Returns the list item downcast converter.
+ *
+ * @internal
+ * @param attributeNames A list of attribute names that should be converted if they are set.
+ * @param strategies The strategies.
+ * @param model The model.
+ */
+export declare function listItemDowncastConverter(attributeNames: Array<string>, strategies: Array<DowncastStrategy>, model: Model): GetCallback<DowncastAttributeEvent<ListElement>>;
+/**
+ * Returns the bogus paragraph view element creator. A bogus paragraph is used if a list item contains only a single block or nested list.
+ *
+ * @internal
+ * @param attributeNames The list of all model list attributes (including registered strategies).
+ */
+export declare function bogusParagraphCreator(attributeNames: Array<string>, { dataPipeline }?: {
+    dataPipeline?: boolean;
+}): ElementCreatorFunction;
+/**
+ * Helper for mapping mode to view elements. It's using positions mapping instead of mapper.toViewElement( element )
+ * to find outermost view element. This is for cases when mapping is using inner view element like in the code blocks (pre > code).
+ *
+ * @internal
+ * @param element The model element.
+ * @param mapper The mapper instance.
+ * @param model The model.
+ */
+export declare function findMappedViewElement(element: Element, mapper: Mapper, model: Model): ViewElement | null;

package/src/documentlist/converters.js

@@ -11,7 +11,7 @@ import { createListElement, createListItemElement, getIndent, isListView, isList
 import ListWalker, { iterateSiblingListBlocks } from './utils/listwalker';
 import { findAndAddListHeadToMap } from './utils/postfixers';
 /**
- * Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) is converted.
+ * Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.
  *
  * @internal
  */
@@ -55,8 +55,8 @@ export function listItemUpcastConverter() {
 }
 /**
  * Returns the upcast converter for the `<ul>` and `<ol>` view elements that cleans the input view of garbage.
- * This is mostly to clean whitespaces from between the `<li>` view elements inside the view list element, however, also
- * incorrect data can be cleared if the view was incorrect.
+ * This is mostly to clean whitespaces from between the `<li>` view elements inside the view list element. However,
+ * incorrect data can also be cleared if the view was incorrect.
  *
  * @internal
  */
@@ -221,7 +221,7 @@ export function reconvertItemsOnDataChange(model, editing, attributeNames, docum
  * Returns the list item downcast converter.
  *
  * @internal
- * @param attributeNames A list of attribute names that should be converted if are set.
+ * @param attributeNames A list of attribute names that should be converted if they are set.
  * @param strategies The strategies.
  * @param model The model.
  */

package/src/documentlist/documentlistcommand.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @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 list/documentlist/documentlistcommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import { Command, type Editor } from 'ckeditor5/src/core';
+import '../listcommands';
+/**
+ * The list command. It is used by the {@link module:list/documentlist~DocumentList document list feature}.
+ */
+export default class DocumentListCommand extends Command {
+    /**
+     * The type of the list created by the command.
+     */
+    readonly type: 'numbered' | 'bulleted';
+    /**
+     * A flag indicating whether the command is active, which means that the selection starts in a list of the same type.
+     *
+     * @observable
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param type List type that will be handled by this command.
+     */
+    constructor(editor: Editor, type: 'numbered' | 'bulleted');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the list command.
+     *
+     * @fires execute
+     * @fires afterExecute
+     * @param options Command options.
+     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will try to convert the
+     * selected items and potentially the neighbor elements to the proper list items. If set to `false` it will convert selected elements
+     * to paragraphs. If not set, the command will toggle selected elements to list items or paragraphs, depending on the selection.
+     */
+    execute(options?: {
+        forceValue?: boolean;
+    }): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks the command's {@link #value}.
+     *
+     * @returns The current value.
+     */
+    private _getValue;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}
+/**
+ * Event fired by the {@link #execute} method.
+ *
+ * It allows to execute an action after executing the {@link ~DocumentListCommand#execute} method,
+ * for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName afterExecute
+ */
+export type DocumentListCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/src/documentlist/documentlistcommand.js

@@ -4,6 +4,7 @@
  */
 import { Command } from 'ckeditor5/src/core';
 import { splitListItemBefore, expandListBlocksToCompleteItems, getListItemBlocks, getListItems, removeListAttributes, outdentFollowingItems, ListItemUid, sortBlocks, getSelectedBlockObject, isListItemBlock } from './utils/model';
+import '../listcommands';
 /**
  * The list command. It is used by the {@link module:list/documentlist~DocumentList document list feature}.
  */

package/src/documentlist/documentlistediting.d.ts

@@ -0,0 +1,156 @@
+/**
+ * @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 list/documentlist/documentlistediting
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import type { DowncastWriter, Element, ViewElement, Writer } from 'ckeditor5/src/engine';
+import { ListBlocksIterable } from './utils/listwalker';
+import '../../theme/documentlist.css';
+import '../../theme/list.css';
+/**
+ * Map of model attributes applicable to list blocks.
+ */
+export interface ListItemAttributesMap {
+    listType?: 'numbered' | 'bulleted';
+    listIndent?: number;
+    listItemId?: string;
+}
+/**
+ * The editing part of the document-list feature. It handles creating, editing and removing lists and list items.
+ */
+export default class DocumentListEditing extends Plugin {
+    /**
+     * The list of registered downcast strategies.
+     */
+    private readonly _downcastStrategies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'DocumentListEditing';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Registers a downcast strategy.
+     *
+     * **Note**: Strategies must be registered in the `Plugin#init()` phase so that it can be applied
+     * in the `DocumentListEditing#afterInit()`.
+     *
+     * @param strategy The downcast strategy to register.
+     */
+    registerDowncastStrategy(strategy: DowncastStrategy): void;
+    /**
+     * Returns list of model attribute names that should affect downcast conversion.
+     */
+    private _getListAttributeNames;
+    /**
+     * Attaches the listener to the {@link module:engine/view/document~Document#event:delete} event and handles backspace/delete
+     * keys in and around document lists.
+     */
+    private _setupDeleteIntegration;
+    /**
+     * Attaches a listener to the {@link module:engine/view/document~Document#event:enter} event and handles enter key press
+     * in document lists.
+     */
+    private _setupEnterIntegration;
+    /**
+     * Attaches a listener to the {@link module:engine/view/document~Document#event:tab} event and handles tab key and tab+shift keys
+     * presses in document lists.
+     */
+    private _setupTabIntegration;
+    /**
+     * Registers the conversion helpers for the document-list feature.
+     */
+    private _setupConversion;
+    /**
+     * Registers model post-fixers.
+     */
+    private _setupModelPostFixing;
+    /**
+     * Integrates the feature with the clipboard via {@link module:engine/model/model~Model#insertContent} and
+     * {@link module:engine/model/model~Model#getSelectedContent}.
+     */
+    private _setupClipboardIntegration;
+}
+/**
+ * The downcast strategy.
+ */
+export interface DowncastStrategy {
+    /**
+     * The scope of the downcast (whether it applies to LI or OL/UL).
+     */
+    scope: 'list' | 'item';
+    /**
+     * The model attribute name.
+     */
+    attributeName: string;
+    /**
+     * Sets the property on the view element.
+     */
+    setAttributeOnDowncast(writer: DowncastWriter, value: unknown, element: ViewElement): void;
+}
+/**
+ * Event fired on changes detected on the model list element to verify if the view representation of a list element
+ * is representing those attributes.
+ *
+ * It allows triggering a re-wrapping of a list item.
+ *
+ * @internal
+ * @eventName postFixer
+ * @param listHead The head element of a list.
+ * @param writer The writer to do changes with.
+ * @param seenIds The set of already known IDs.
+ * @returns If a post-fixer made a change of the model tree, it should return `true`.
+ */
+export type DocumentListEditingPostFixerEvent = {
+    name: 'postFixer';
+    args: [
+        {
+            listNodes: ListBlocksIterable;
+            listHead: Element;
+            writer: Writer;
+            seenIds: Set<string>;
+        }
+    ];
+    return: boolean;
+};
+/**
+ * Event fired on changes detected on the model list element to verify if the view representation of a list element
+ * is representing those attributes.
+ *
+ * It allows triggering a re-wrapping of a list item.
+ *
+ * **Note**: For convenience this event is namespaced and could be captured as `checkAttributes:list` or `checkAttributes:item`.
+ *
+ * @internal
+ * @eventName checkAttributes
+ */
+export type DocumentListEditingCheckAttributesEvent = {
+    name: 'checkAttributes' | 'checkAttributes:list' | 'checkAttributes:item';
+    args: [
+        {
+            viewElement: ViewElement & {
+                id?: string;
+            };
+            modelAttributes: ListItemAttributesMap;
+        }
+    ];
+    return: boolean;
+};
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [DocumentListEditing.pluginName]: DocumentListEditing;
+    }
+}

package/src/documentlist/documentlistindentcommand.d.ts

@@ -0,0 +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 list/documentlist/documentlistindentcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { Element } from 'ckeditor5/src/engine';
+import '../listcommands';
+/**
+ * The document list indent command. It is used by the {@link module:list/documentlist~DocumentList list feature}.
+ */
+export default class DocumentListIndentCommand extends Command {
+    /**
+     * Determines by how much the command will change the list item's indent attribute.
+     */
+    private readonly _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param indentDirection The direction of indent. If it is equal to `backward`, the command
+     * will outdent a list item.
+     */
+    constructor(editor: Editor, indentDirection: 'forward' | 'backward');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Indents or outdents (depending on the {@link #constructor}'s `indentDirection` parameter) selected list items.
+     *
+     * @fires execute
+     * @fires afterExecute
+     */
+    execute(): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}
+/**
+ * Event fired by the {@link #execute} method.
+ *
+ * It allows to execute an action after executing the {@link ~DocumentListCommand#execute} method,
+ * for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName afterExecute
+ */
+export type DocumentListIndentCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/src/documentlist/documentlistindentcommand.js

@@ -8,6 +8,7 @@
 import { Command } from 'ckeditor5/src/core';
 import { expandListBlocksToCompleteItems, indentBlocks, isFirstBlockOfListItem, isListItemBlock, isSingleListItem, outdentBlocksWithMerge, sortBlocks, splitListItemBefore } from './utils/model';
 import ListWalker from './utils/listwalker';
+import '../listcommands';
 /**
  * The document list indent command. It is used by the {@link module:list/documentlist~DocumentList list feature}.
  */

package/src/documentlist/documentlistmergecommand.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @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 list/documentlist/documentlistmergecommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { Element } from 'ckeditor5/src/engine';
+import '../listcommands';
+/**
+ * The document list merge command. It is used by the {@link module:list/documentlist~DocumentList list feature}.
+ */
+export default class DocumentListMergeCommand extends Command {
+    /**
+     * Whether list item should be merged before or after the selected block.
+     */
+    private readonly _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction Whether list item should be merged before or after the selected block.
+     */
+    constructor(editor: Editor, direction: 'forward' | 'backward');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Merges list blocks together (depending on the {@link #constructor}'s `direction` parameter).
+     *
+     * @fires execute
+     * @fires afterExecute
+     * @param options Command options.
+     * @param options.shouldMergeOnBlocksContentLevel When set `true`, merging will be performed together
+     * with {@link module:engine/model/model~Model#deleteContent} to get rid of the inline content in the selection or take advantage
+     * of the heuristics in `deleteContent()` that helps convert lists into paragraphs in certain cases.
+     */
+    execute({ shouldMergeOnBlocksContentLevel }?: {
+        shouldMergeOnBlocksContentLevel?: boolean;
+    }): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+    /**
+     * Returns the boundary elements the merge should be executed for. These are not necessarily selection's first
+     * and last position parents but sometimes sibling or even further blocks depending on the context.
+     *
+     * @param selection The selection the merge is executed for.
+     * @param shouldMergeOnBlocksContentLevel When `true`, merge is performed together with
+     * {@link module:engine/model/model~Model#deleteContent} to remove the inline content within the selection.
+     */
+    private _getMergeSubjectElements;
+}
+/**
+ * Event fired by the {@link #execute} method.
+ *
+ * It allows to execute an action after executing the {@link ~DocumentListCommand#execute} method,
+ * for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName afterExecute
+ */
+export type DocumentListMergeCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/src/documentlist/documentlistmergecommand.js

@@ -8,6 +8,7 @@
 import { Command } from 'ckeditor5/src/core';
 import { getNestedListBlocks, indentBlocks, sortBlocks, isFirstBlockOfListItem, mergeListItemBefore, isSingleListItem, getSelectedBlockObject, isListItemBlock } from './utils/model';
 import ListWalker from './utils/listwalker';
+import '../listcommands';
 /**
  * The document list merge command. It is used by the {@link module:list/documentlist~DocumentList list feature}.
  */

package/src/documentlist/documentlistsplitcommand.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 list/documentlist/documentlistsplitcommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import { Command, type Editor } from 'ckeditor5/src/core';
+import '../listcommands';
+/**
+ * The document list split command that splits the list item at the selection.
+ *
+ * It is used by the {@link module:list/documentlist~DocumentList document list feature}.
+ */
+export default class DocumentListSplitCommand extends Command {
+    /**
+     * Whether list item should be split before or after the selected block.
+     */
+    private readonly _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction Whether list item should be split before or after the selected block.
+     */
+    constructor(editor: Editor, direction: 'before' | 'after');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Splits the list item at the selection.
+     *
+     * @fires execute
+     * @fires afterExecute
+     */
+    execute(): void;
+    /**
+     * Fires the `afterExecute` event.
+     *
+     * @param changedBlocks The changed list elements.
+     */
+    private _fireAfterExecute;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+    /**
+     * Returns the model element that is the main focus of the command (according to the current selection and command direction).
+     */
+    private _getStartBlock;
+}
+/**
+ * Event fired by the {@link #execute} method.
+ *
+ * It allows to execute an action after executing the {@link ~DocumentListCommand#execute} method,
+ * for example adjusting attributes of changed list items.
+ *
+ * @internal
+ * @eventName afterExecute
+ */
+export type DocumentListSplitCommandAfterExecuteEvent = {
+    name: 'afterExecute';
+    args: [changedBlocks: Array<Element>];
+};

package/src/documentlist/documentlistsplitcommand.js

@@ -4,6 +4,7 @@
  */
 import { Command } from 'ckeditor5/src/core';
 import { isFirstBlockOfListItem, isListItemBlock, sortBlocks, splitListItemBefore } from './utils/model';
+import '../listcommands';
 /**
  * The document list split command that splits the list item at the selection.
  *