@ckeditor/ckeditor5-indent 36.0.1 → 37.0.0-alpha.1

package/build/indent.js

@@ -2,4 +2,4 @@
 /*!
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
- */(()=>{var t={704:(t,e,n)=>{t.exports=n(79)("./src/core.js")},492:(t,e,n)=>{t.exports=n(79)("./src/engine.js")},273:(t,e,n)=>{t.exports=n(79)("./src/ui.js")},209:(t,e,n)=>{t.exports=n(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function n(s){var i=e[s];if(void 0!==i)return i.exports;var o=e[s]={exports:{}};return t[s](o,o.exports,n),o.exports}n.d=(t,e)=>{for(var s in e)n.o(e,s)&&!n.o(t,s)&&Object.defineProperty(t,s,{enumerable:!0,get:e[s]})},n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),n.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var s={};(()=>{"use strict";n.r(s),n.d(s,{Indent:()=>a,IndentBlock:()=>f,IndentEditing:()=>e,IndentUI:()=>d});var t=n(704);class e extends t.Plugin{static get pluginName(){return"IndentEditing"}init(){const e=this.editor;e.commands.add("indent",new t.MultiCommand(e)),e.commands.add("outdent",new t.MultiCommand(e))}}var i=n(273);const o='<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M2 3.75c0 .414.336.75.75.75h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 0 0-.75.75zm5 6c0 .414.336.75.75.75h9.5a.75.75 0 1 0 0-1.5h-9.5a.75.75 0 0 0-.75.75zM2.75 16.5h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 1 0 0 1.5zM1.632 6.95 5.02 9.358a.4.4 0 0 1-.013.661l-3.39 2.207A.4.4 0 0 1 1 11.892V7.275a.4.4 0 0 1 .632-.326z"/></svg>',r='<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M2 3.75c0 .414.336.75.75.75h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 0 0-.75.75zm5 6c0 .414.336.75.75.75h9.5a.75.75 0 1 0 0-1.5h-9.5a.75.75 0 0 0-.75.75zM2.75 16.5h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 1 0 0 1.5zm1.618-9.55L.98 9.358a.4.4 0 0 0 .013.661l3.39 2.207A.4.4 0 0 0 5 11.892V7.275a.4.4 0 0 0-.632-.326z"/></svg>';class d extends t.Plugin{static get pluginName(){return"IndentUI"}init(){const t=this.editor,e=t.locale,n=t.t,s="ltr"==e.uiLanguageDirection?o:r,i="ltr"==e.uiLanguageDirection?r:o;this._defineButton("indent",n("Increase indent"),s),this._defineButton("outdent",n("Decrease indent"),i)}_defineButton(t,e,n){const s=this.editor;s.ui.componentFactory.add(t,(o=>{const r=s.commands.get(t),d=new i.ButtonView(o);return d.set({label:e,icon:n,tooltip:!0}),d.bind("isOn","isEnabled").to(r,"value","isEnabled"),this.listenTo(d,"execute",(()=>{s.execute(t),s.editing.view.focus()})),d}))}}class a extends t.Plugin{static get pluginName(){return"Indent"}static get requires(){return[e,d]}}var c=n(492),l=n(209);class u extends t.Command{constructor(t,e){super(t),this._indentBehavior=e}refresh(){const t=this.editor.model,e=(0,l.first)(t.document.selection.getSelectedBlocks());e&&t.schema.checkAttribute(e,"blockIndent")?this.isEnabled=this._indentBehavior.checkEnabled(e.getAttribute("blockIndent")):this.isEnabled=!1}execute(){const t=this.editor.model,e=function(t){const e=t.document.selection,n=t.schema;return Array.from(e.getSelectedBlocks()).filter((t=>n.checkAttribute(t,"blockIndent")))}(t);t.change((t=>{for(const n of e){const e=n.getAttribute("blockIndent"),s=this._indentBehavior.getNextIndent(e);s?t.setAttribute("blockIndent",s,n):t.removeAttribute("blockIndent",n)}}))}}class h{constructor(t){this.isForward="forward"===t.direction,this.offset=t.offset,this.unit=t.unit}checkEnabled(t){const e=parseFloat(t||0);return this.isForward||e>0}getNextIndent(t){const e=parseFloat(t||0);if(!(!t||t.endsWith(this.unit)))return this.isForward?this.offset+this.unit:void 0;const n=e+(this.isForward?this.offset:-this.offset);return n>0?n+this.unit:void 0}}class g{constructor(t){this.isForward="forward"===t.direction,this.classes=t.classes}checkEnabled(t){const e=this.classes.indexOf(t);return this.isForward?e<this.classes.length-1:e>=0}getNextIndent(t){const e=this.classes.indexOf(t),n=this.isForward?1:-1;return this.classes[e+n]}}const m=["paragraph","heading1","heading2","heading3","heading4","heading5","heading6"];class f extends t.Plugin{constructor(t){super(t),t.config.define("indentBlock",{offset:40,unit:"px"})}static get pluginName(){return"IndentBlock"}init(){const t=this.editor,e=t.config.get("indentBlock"),n=!e.classes||!e.classes.length,s=Object.assign({direction:"forward"},e),i=Object.assign({direction:"backward"},e);n?(t.data.addStyleProcessorRules(c.addMarginRules),this._setupConversionUsingOffset(t.conversion),t.commands.add("indentBlock",new u(t,new h(s))),t.commands.add("outdentBlock",new u(t,new h(i)))):(this._setupConversionUsingClasses(e.classes),t.commands.add("indentBlock",new u(t,new g(s))),t.commands.add("outdentBlock",new u(t,new g(i))))}afterInit(){const t=this.editor,e=t.model.schema,n=t.commands.get("indent"),s=t.commands.get("outdent"),i=t.config.get("heading.options");(i&&i.map((t=>t.model))||m).forEach((t=>{e.isRegistered(t)&&e.extend(t,{allowAttributes:"blockIndent"})})),e.setAttributeProperties("blockIndent",{isFormatting:!0}),n.registerChildCommand(t.commands.get("indentBlock")),s.registerChildCommand(t.commands.get("outdentBlock"))}_setupConversionUsingOffset(){const t=this.editor.conversion,e="rtl"===this.editor.locale.contentLanguageDirection?"margin-right":"margin-left";t.for("upcast").attributeToAttribute({view:{styles:{[e]:/[\s\S]+/}},model:{key:"blockIndent",value:t=>t.getStyle(e)}}),t.for("downcast").attributeToAttribute({model:"blockIndent",view:t=>({key:"style",value:{[e]:t}})})}_setupConversionUsingClasses(t){const e={model:{key:"blockIndent",values:[]},view:{}};for(const n of t)e.model.values.push(n),e.view[n]={key:"class",value:[n]};this.editor.conversion.attributeToAttribute(e)}}})(),(window.CKEditor5=window.CKEditor5||{}).indent=s})();
+ */(()=>{var t={704:(t,e,n)=>{t.exports=n(79)("./src/core.js")},492:(t,e,n)=>{t.exports=n(79)("./src/engine.js")},273:(t,e,n)=>{t.exports=n(79)("./src/ui.js")},209:(t,e,n)=>{t.exports=n(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function n(s){var i=e[s];if(void 0!==i)return i.exports;var o=e[s]={exports:{}};return t[s](o,o.exports,n),o.exports}n.d=(t,e)=>{for(var s in e)n.o(e,s)&&!n.o(t,s)&&Object.defineProperty(t,s,{enumerable:!0,get:e[s]})},n.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),n.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var s={};(()=>{"use strict";n.r(s),n.d(s,{Indent:()=>a,IndentBlock:()=>f,IndentEditing:()=>e,IndentUI:()=>d});var t=n(704);class e extends t.Plugin{static get pluginName(){return"IndentEditing"}init(){const e=this.editor;e.commands.add("indent",new t.MultiCommand(e)),e.commands.add("outdent",new t.MultiCommand(e))}}var i=n(273);const o='<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M2 3.75c0 .414.336.75.75.75h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 0 0-.75.75zm5 6c0 .414.336.75.75.75h9.5a.75.75 0 1 0 0-1.5h-9.5a.75.75 0 0 0-.75.75zM2.75 16.5h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 1 0 0 1.5zM1.632 6.95 5.02 9.358a.4.4 0 0 1-.013.661l-3.39 2.207A.4.4 0 0 1 1 11.892V7.275a.4.4 0 0 1 .632-.326z"/></svg>',r='<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path d="M2 3.75c0 .414.336.75.75.75h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 0 0-.75.75zm5 6c0 .414.336.75.75.75h9.5a.75.75 0 1 0 0-1.5h-9.5a.75.75 0 0 0-.75.75zM2.75 16.5h14.5a.75.75 0 1 0 0-1.5H2.75a.75.75 0 1 0 0 1.5zm1.618-9.55L.98 9.358a.4.4 0 0 0 .013.661l3.39 2.207A.4.4 0 0 0 5 11.892V7.275a.4.4 0 0 0-.632-.326z"/></svg>';class d extends t.Plugin{static get pluginName(){return"IndentUI"}init(){const t=this.editor,e=t.locale,n=t.t,s="ltr"==e.uiLanguageDirection?o:r,i="ltr"==e.uiLanguageDirection?r:o;this._defineButton("indent",n("Increase indent"),s),this._defineButton("outdent",n("Decrease indent"),i)}_defineButton(t,e,n){const s=this.editor;s.ui.componentFactory.add(t,(o=>{const r=s.commands.get(t),d=new i.ButtonView(o);return d.set({label:e,icon:n,tooltip:!0}),d.bind("isEnabled").to(r,"isEnabled"),this.listenTo(d,"execute",(()=>{s.execute(t),s.editing.view.focus()})),d}))}}class a extends t.Plugin{static get pluginName(){return"Indent"}static get requires(){return[e,d]}}var c=n(492),l=n(209);class u extends t.Command{constructor(t,e){super(t),this._indentBehavior=e}refresh(){const t=this.editor.model,e=(0,l.first)(t.document.selection.getSelectedBlocks());e&&t.schema.checkAttribute(e,"blockIndent")?this.isEnabled=this._indentBehavior.checkEnabled(e.getAttribute("blockIndent")):this.isEnabled=!1}execute(){const t=this.editor.model,e=function(t){const e=t.document.selection,n=t.schema;return Array.from(e.getSelectedBlocks()).filter((t=>n.checkAttribute(t,"blockIndent")))}(t);t.change((t=>{for(const n of e){const e=n.getAttribute("blockIndent"),s=this._indentBehavior.getNextIndent(e);s?t.setAttribute("blockIndent",s,n):t.removeAttribute("blockIndent",n)}}))}}class h{constructor(t){this.isForward="forward"===t.direction,this.offset=t.offset,this.unit=t.unit}checkEnabled(t){const e=parseFloat(t||"0");return this.isForward||e>0}getNextIndent(t){const e=parseFloat(t||"0");if(!(!t||t.endsWith(this.unit)))return this.isForward?this.offset+this.unit:void 0;const n=e+(this.isForward?this.offset:-this.offset);return n>0?n+this.unit:void 0}}class g{constructor(t){this.isForward="forward"===t.direction,this.classes=t.classes}checkEnabled(t){const e=this.classes.indexOf(t);return this.isForward?e<this.classes.length-1:e>=0}getNextIndent(t){const e=this.classes.indexOf(t),n=this.isForward?1:-1;return this.classes[e+n]}}const m=["paragraph","heading1","heading2","heading3","heading4","heading5","heading6"];class f extends t.Plugin{constructor(t){super(t),t.config.define("indentBlock",{offset:40,unit:"px"})}static get pluginName(){return"IndentBlock"}init(){const t=this.editor,e=t.config.get("indentBlock");e.classes&&e.classes.length?(this._setupConversionUsingClasses(e.classes),t.commands.add("indentBlock",new u(t,new g({direction:"forward",classes:e.classes}))),t.commands.add("outdentBlock",new u(t,new g({direction:"backward",classes:e.classes})))):(t.data.addStyleProcessorRules(c.addMarginRules),this._setupConversionUsingOffset(),t.commands.add("indentBlock",new u(t,new h({direction:"forward",offset:e.offset,unit:e.unit}))),t.commands.add("outdentBlock",new u(t,new h({direction:"backward",offset:e.offset,unit:e.unit}))))}afterInit(){const t=this.editor,e=t.model.schema,n=t.commands.get("indent"),s=t.commands.get("outdent"),i=t.config.get("heading.options");(i&&i.map((t=>t.model))||m).forEach((t=>{e.isRegistered(t)&&e.extend(t,{allowAttributes:"blockIndent"})})),e.setAttributeProperties("blockIndent",{isFormatting:!0}),n.registerChildCommand(t.commands.get("indentBlock")),s.registerChildCommand(t.commands.get("outdentBlock"))}_setupConversionUsingOffset(){const t=this.editor.conversion,e="rtl"===this.editor.locale.contentLanguageDirection?"margin-right":"margin-left";t.for("upcast").attributeToAttribute({view:{styles:{[e]:/[\s\S]+/}},model:{key:"blockIndent",value:t=>t.getStyle(e)}}),t.for("downcast").attributeToAttribute({model:"blockIndent",view:t=>({key:"style",value:{[e]:t}})})}_setupConversionUsingClasses(t){const e={model:{key:"blockIndent",values:[]},view:{}};for(const n of t)e.model.values.push(n),e.view[n]={key:"class",value:[n]};this.editor.conversion.attributeToAttribute(e)}}})(),(window.CKEditor5=window.CKEditor5||{}).indent=s})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-indent",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.1",
   "description": "Block indentation feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,17 +12,18 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.1"
+    "ckeditor5": "^37.0.0-alpha.1"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
-    "@ckeditor/ckeditor5-engine": "^36.0.1",
-    "@ckeditor/ckeditor5-heading": "^36.0.1",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
-    "@ckeditor/ckeditor5-ui": "^36.0.1",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.1",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -41,13 +42,17 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
   "scripts": {
-    "dll:build": "webpack"
-  }
+    "dll:build": "webpack",
+    "build": "tsc -p ./tsconfig.json",
+    "postversion": "npm run build"
+  },
+  "types": "src/index.d.ts"
 }

package/src/augmentation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @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 { IndentBlockConfig, Indent, IndentBlock, IndentUI, IndentBlockCommand } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
+         *
+         * Read more in {@link module:indent/indentconfig~IndentBlockConfig}.
+         */
+        indentBlock?: IndentBlockConfig;
+    }
+    interface PluginsMap {
+        [Indent.pluginName]: Indent;
+        [IndentBlock.pluginName]: IndentBlock;
+        [IndentUI.pluginName]: IndentUI;
+    }
+    interface CommandsMap {
+        indentBlock: IndentBlockCommand;
+        outdentBlock: IndentBlockCommand;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/indent.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @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 indent/indent
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * The indent feature.
+ *
+ * This plugin acts as a single entry point plugin for other features that implement indentation of elements like lists or paragraphs.
+ *
+ * The compatible features are:
+ *
+ * * The {@link module:list/list~List} or {@link module:list/list/listediting~ListEditing} feature for list indentation.
+ * * The {@link module:indent/indentblock~IndentBlock} feature for block indentation.
+ *
+ * This is a "glue" plugin that loads the following plugins:
+ *
+ * * The {@link module:indent/indentediting~IndentEditing indent editing feature}.
+ * * The {@link module:indent/indentui~IndentUI indent UI feature}.
+ *
+ * The dependent plugins register the `'indent'` and `'outdent'` commands and introduce the `'indent'` and `'outdent'` buttons
+ * that allow to increase or decrease text indentation of supported elements.
+ *
+ * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
+ */
+export default class Indent extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Indent';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+}

package/src/indent.js

@@ -2,16 +2,12 @@
  * @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 indent/indent
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import IndentEditing from './indentediting';
 import IndentUI from './indentui';
-
 /**
  * The indent feature.
  *
@@ -31,21 +27,18 @@ import IndentUI from './indentui';
  * that allow to increase or decrease text indentation of supported elements.
  *
  * **Note**: In order for the commands and buttons to work, at least one of compatible features is required.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class Indent extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'Indent';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ IndentEditing, IndentUI ];
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Indent';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [IndentEditing, IndentUI];
+    }
 }

package/src/indentblock.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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 indent/indentblock
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The block indentation feature.
+ *
+ * It registers the `'indentBlock'` and `'outdentBlock'` commands.
+ *
+ * If the plugin {@link module:indent/indent~Indent} is defined, it also attaches the `'indentBlock'` and `'outdentBlock'` commands to
+ * the `'indent'` and `'outdent'` commands.
+ */
+export default class IndentBlock extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'IndentBlock';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Setups conversion for using offset indents.
+     */
+    private _setupConversionUsingOffset;
+    /**
+     * Setups conversion for using classes.
+     */
+    private _setupConversionUsingClasses;
+}

package/src/indentblock.js

@@ -2,20 +2,15 @@
  * @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 indent/indentblock
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { addMarginRules } from 'ckeditor5/src/engine';
-
 import IndentBlockCommand from './indentblockcommand';
 import IndentUsingOffset from './indentcommandbehavior/indentusingoffset';
 import IndentUsingClasses from './indentcommandbehavior/indentusingclasses';
-
-const DEFAULT_ELEMENTS = [ 'paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6' ];
-
+const DEFAULT_ELEMENTS = ['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
 /**
  * The block indentation feature.
  *
@@ -23,212 +18,125 @@ const DEFAULT_ELEMENTS = [ 'paragraph', 'heading1', 'heading2', 'heading3', 'hea
  *
  * If the plugin {@link module:indent/indent~Indent} is defined, it also attaches the `'indentBlock'` and `'outdentBlock'` commands to
  * the `'indent'` and `'outdent'` commands.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class IndentBlock extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	constructor( editor ) {
-		super( editor );
-
-		editor.config.define( 'indentBlock', {
-			offset: 40,
-			unit: 'px'
-		} );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'IndentBlock';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-		const configuration = editor.config.get( 'indentBlock' );
-
-		const useOffsetConfig = !configuration.classes || !configuration.classes.length;
-
-		const indentConfig = Object.assign( { direction: 'forward' }, configuration );
-		const outdentConfig = Object.assign( { direction: 'backward' }, configuration );
-
-		if ( useOffsetConfig ) {
-			editor.data.addStyleProcessorRules( addMarginRules );
-			this._setupConversionUsingOffset( editor.conversion );
-
-			editor.commands.add( 'indentBlock', new IndentBlockCommand( editor, new IndentUsingOffset( indentConfig ) ) );
-			editor.commands.add( 'outdentBlock', new IndentBlockCommand( editor, new IndentUsingOffset( outdentConfig ) ) );
-		} else {
-			this._setupConversionUsingClasses( configuration.classes );
-			editor.commands.add( 'indentBlock', new IndentBlockCommand( editor, new IndentUsingClasses( indentConfig ) ) );
-			editor.commands.add( 'outdentBlock', new IndentBlockCommand( editor, new IndentUsingClasses( outdentConfig ) ) );
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	afterInit() {
-		const editor = this.editor;
-		const schema = editor.model.schema;
-
-		const indentCommand = editor.commands.get( 'indent' );
-		const outdentCommand = editor.commands.get( 'outdent' );
-
-		// Enable block indentation to heading configuration options. If it is not defined enable in paragraph and default headings.
-		const options = editor.config.get( 'heading.options' );
-		const configuredElements = options && options.map( option => option.model );
-		const knownElements = configuredElements || DEFAULT_ELEMENTS;
-
-		knownElements.forEach( elementName => {
-			if ( schema.isRegistered( elementName ) ) {
-				schema.extend( elementName, { allowAttributes: 'blockIndent' } );
-			}
-		} );
-
-		schema.setAttributeProperties( 'blockIndent', { isFormatting: true } );
-
-		indentCommand.registerChildCommand( editor.commands.get( 'indentBlock' ) );
-		outdentCommand.registerChildCommand( editor.commands.get( 'outdentBlock' ) );
-	}
-
-	/**
-	 * Setups conversion for using offset indents.
-	 *
-	 * @private
-	 */
-	_setupConversionUsingOffset() {
-		const conversion = this.editor.conversion;
-		const locale = this.editor.locale;
-		const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
-
-		conversion.for( 'upcast' ).attributeToAttribute( {
-			view: {
-				styles: {
-					[ marginProperty ]: /[\s\S]+/
-				}
-			},
-			model: {
-				key: 'blockIndent',
-				value: viewElement => viewElement.getStyle( marginProperty )
-			}
-		} );
-
-		conversion.for( 'downcast' ).attributeToAttribute( {
-			model: 'blockIndent',
-			view: modelAttributeValue => {
-				return {
-					key: 'style',
-					value: {
-						[ marginProperty ]: modelAttributeValue
-					}
-				};
-			}
-		} );
-	}
-
-	/**
-	 * Setups conversion for using classes.
-	 *
-	 * @param {Array.<String>} classes
-	 * @private
-	 */
-	_setupConversionUsingClasses( classes ) {
-		const definition = {
-			model: {
-				key: 'blockIndent',
-				values: []
-			},
-			view: {}
-		};
-
-		for ( const className of classes ) {
-			definition.model.values.push( className );
-			definition.view[ className ] = {
-				key: 'class',
-				value: [ className ]
-			};
-		}
-
-		this.editor.conversion.attributeToAttribute( definition );
-	}
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('indentBlock', {
+            offset: 40,
+            unit: 'px'
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'IndentBlock';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const configuration = editor.config.get('indentBlock');
+        if (configuration.classes && configuration.classes.length) {
+            this._setupConversionUsingClasses(configuration.classes);
+            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
+                direction: 'forward',
+                classes: configuration.classes
+            })));
+            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingClasses({
+                direction: 'backward',
+                classes: configuration.classes
+            })));
+        }
+        else {
+            editor.data.addStyleProcessorRules(addMarginRules);
+            this._setupConversionUsingOffset();
+            editor.commands.add('indentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
+                direction: 'forward',
+                offset: configuration.offset,
+                unit: configuration.unit
+            })));
+            editor.commands.add('outdentBlock', new IndentBlockCommand(editor, new IndentUsingOffset({
+                direction: 'backward',
+                offset: configuration.offset,
+                unit: configuration.unit
+            })));
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const editor = this.editor;
+        const schema = editor.model.schema;
+        const indentCommand = editor.commands.get('indent');
+        const outdentCommand = editor.commands.get('outdent');
+        // Enable block indentation to heading configuration options. If it is not defined enable in paragraph and default headings.
+        const options = editor.config.get('heading.options');
+        const configuredElements = options && options.map(option => option.model);
+        const knownElements = configuredElements || DEFAULT_ELEMENTS;
+        knownElements.forEach(elementName => {
+            if (schema.isRegistered(elementName)) {
+                schema.extend(elementName, { allowAttributes: 'blockIndent' });
+            }
+        });
+        schema.setAttributeProperties('blockIndent', { isFormatting: true });
+        indentCommand.registerChildCommand(editor.commands.get('indentBlock'));
+        outdentCommand.registerChildCommand(editor.commands.get('outdentBlock'));
+    }
+    /**
+     * Setups conversion for using offset indents.
+     */
+    _setupConversionUsingOffset() {
+        const conversion = this.editor.conversion;
+        const locale = this.editor.locale;
+        const marginProperty = locale.contentLanguageDirection === 'rtl' ? 'margin-right' : 'margin-left';
+        conversion.for('upcast').attributeToAttribute({
+            view: {
+                styles: {
+                    [marginProperty]: /[\s\S]+/
+                }
+            },
+            model: {
+                key: 'blockIndent',
+                value: (viewElement) => viewElement.getStyle(marginProperty)
+            }
+        });
+        conversion.for('downcast').attributeToAttribute({
+            model: 'blockIndent',
+            view: modelAttributeValue => {
+                return {
+                    key: 'style',
+                    value: {
+                        [marginProperty]: modelAttributeValue
+                    }
+                };
+            }
+        });
+    }
+    /**
+     * Setups conversion for using classes.
+     */
+    _setupConversionUsingClasses(classes) {
+        const definition = {
+            model: {
+                key: 'blockIndent',
+                values: []
+            },
+            view: {}
+        };
+        for (const className of classes) {
+            definition.model.values.push(className);
+            definition.view[className] = {
+                key: 'class',
+                value: [className]
+            };
+        }
+        this.editor.conversion.attributeToAttribute(definition);
+    }
 }
-
-/**
- * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
- *
- * Read more in {@link module:indent/indentblock~IndentBlockConfig}.
- *
- * @member {module:indent/indentblock~IndentBlockConfig} module:core/editor/editorconfig~EditorConfig#indentBlock
- */
-
-/**
- * The configuration of the block indentation feature.
- *
- * If no {@link module:indent/indentblock~IndentBlockConfig#classes} are set, the block indentation feature will use
- * {@link module:indent/indentblock~IndentBlockConfig#offset} and {@link module:indent/indentblock~IndentBlockConfig#unit} to
- * create indentation steps.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- * 				indentBlock: {
- *					offset: 2,
- *					unit: 'em'
- * 				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
- *
- * Alternatively, the block indentation feature may set one of defined {@link module:indent/indentblock~IndentBlockConfig#classes} as
- * indentation steps:
- *
- *		ClassicEditor
- *			.create( editorElement, {
- * 				indentBlock: {
- *					classes: [
- *						'indent-a', // The first step - smallest indentation.
- *						'indent-b',
- *						'indent-c',
- *						'indent-d',
- *						'indent-e' // The last step - biggest indentation.
- *					]
- * 				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
- *
- * In the example above only 5 indentation steps will be available.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- *
- * @interface IndentBlockConfig
- */
-
-/**
- * The size of indentation {@link module:indent/indentblock~IndentBlockConfig#unit units} for each indentation step.
- *
- * @default 40
- * @member {Number} module:indent/indentblock~IndentBlockConfig#offset
- */
-
-/**
- * The unit used for indentation {@link module:indent/indentblock~IndentBlockConfig#offset}.
- *
- * @default 'px'
- * @member {String} module:indent/indentblock~IndentBlockConfig#unit
- */
-
-/**
- * An optional list of classes to use for indenting the editor content. If not set or set to an empty array, no classes will be used.
- * The {@link module:indent/indentblock~IndentBlockConfig#unit `indentBlock.unit`} and
- * {@link module:indent/indentblock~IndentBlockConfig#offset `indentBlock.offset`} properties will be used instead.
- *
- * @default undefined
- * @member {Array.<String>|undefined} module:indent/indentblock~IndentBlockConfig#classes
- */

package/src/indentblockcommand.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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 indent/indentblockcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { IndentBehavior } from './indentcommandbehavior/indentbehavior';
+/**
+ * The indent block command.
+ *
+ * The command is registered by the {@link module:indent/indentblock~IndentBlock} as `'indentBlock'` for indenting blocks and
+ * `'outdentBlock'` for outdenting blocks.
+ *
+ * To increase block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'indentBlock' );
+ * ```
+ *
+ * To decrease block indentation at the current selection, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'outdentBlock' );
+ * ```
+ */
+export default class IndentBlockCommand extends Command {
+    /**
+     * The command's indentation behavior.
+     */
+    private readonly _indentBehavior;
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor: Editor, indentBehavior: IndentBehavior);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}