@ckeditor/ckeditor5-select-all 36.0.0 → 37.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-select-all",
-  "version": "36.0.0",
+  "version": "37.0.0-alpha.0",
   "description": "Select all feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,19 +12,19 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^36.0.0",
-    "@ckeditor/ckeditor5-utils": "^36.0.0",
-    "@ckeditor/ckeditor5-ui": "^36.0.0"
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
-    "@ckeditor/ckeditor5-engine": "^36.0.0",
-    "@ckeditor/ckeditor5-essentials": "^36.0.0",
-    "@ckeditor/ckeditor5-heading": "^36.0.0",
-    "@ckeditor/ckeditor5-image": "^36.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
-    "@ckeditor/ckeditor5-table": "^36.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -53,5 +53,6 @@
   "scripts": {
     "build": "tsc -p ./tsconfig.release.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @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 select-all
+ */
+export { default as SelectAll } from './selectall';
+export { default as SelectAllEditing } from './selectallediting';
+export { default as SelectAllUI } from './selectallui';

package/src/selectall.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 select-all/selectall
+ */
+import { Plugin, type PluginDependencies } from '@ckeditor/ckeditor5-core';
+/**
+ * The select all feature.
+ *
+ * This is a "glue" plugin which loads the {@link module:select-all/selectallediting~SelectAllEditing select all editing feature}
+ * and the {@link module:select-all/selectallui~SelectAllUI select all UI feature}.
+ *
+ * Please refer to the documentation of individual features to learn more.
+ */
+export default class SelectAll extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'SelectAll';
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [SelectAll.pluginName]: SelectAll;
+    }
+}

package/src/selectall.js

@@ -15,8 +15,6 @@ import SelectAllUI from './selectallui';
  * and the {@link module:select-all/selectallui~SelectAllUI select all UI feature}.
  *
  * Please refer to the documentation of individual features to learn more.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class SelectAll extends Plugin {
     /**

package/src/selectallcommand.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module select-all/selectallcommand
+ */
+import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+/**
+ * The select all command.
+ *
+ * It is used by the {@link module:select-all/selectallediting~SelectAllEditing select all editing feature} to handle
+ * the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke.
+ *
+ * Executing this command changes the {@glink framework/architecture/editing-engine#model model}
+ * selection so it contains the entire content of the editable root of the editor the selection is
+ * {@link module:engine/model/selection~Selection#anchor anchored} in.
+ *
+ * If the selection was anchored in a {@glink framework/tutorials/implementing-a-block-widget nested editable}
+ * (e.g. a caption of an image), the new selection will contain its entire content. Successive executions of this command
+ * will expand the selection to encompass more and more content up to the entire editable root of the editor.
+ */
+export default class SelectAllCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        selectAll: SelectAllCommand;
+    }
+}

package/src/selectallcommand.js

@@ -12,15 +12,13 @@ import { Command } from '@ckeditor/ckeditor5-core';
  * It is used by the {@link module:select-all/selectallediting~SelectAllEditing select all editing feature} to handle
  * the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke.
  *
- * Executing this command changes the {@glink framework/guides/architecture/editing-engine#model model}
+ * Executing this command changes the {@glink framework/architecture/editing-engine#model model}
  * selection so it contains the entire content of the editable root of the editor the selection is
  * {@link module:engine/model/selection~Selection#anchor anchored} in.
  *
- * If the selection was anchored in a {@glink framework/guides/tutorials/implementing-a-block-widget nested editable}
+ * If the selection was anchored in a {@glink framework/tutorials/implementing-a-block-widget nested editable}
  * (e.g. a caption of an image), the new selection will contain its entire content. Successive executions of this command
  * will expand the selection to encompass more and more content up to the entire editable root of the editor.
- *
- * @extends module:core/command~Command
  */
 export default class SelectAllCommand extends Command {
     /**
@@ -54,13 +52,13 @@ export default class SelectAllCommand extends Command {
         });
     }
 }
-// Checks whether the element is a valid select-all scope.
-// Returns true, if the element is a {@link module:engine/model/schema~Schema#isLimit limit},
-// and can contain any text or paragraph.
-//
-// @param {module:engine/model/schema~Schema} schema The schema to check against.
-// @param {module:engine/model/element~Element} element
-// @return {Boolean}
+/**
+ * Checks whether the element is a valid select-all scope. Returns true, if the element is a
+ * {@link module:engine/model/schema~Schema#isLimit limit}, and can contain any text or paragraph.
+ *
+ * @param schema Schema to check against.
+ * @param element Model element.
+ */
 function isSelectAllScope(schema, element) {
     return schema.isLimit(element) && (schema.checkChild(element, '$text') || schema.checkChild(element, 'paragraph'));
 }

package/src/selectallediting.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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 select-all/selectallediting
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The select all editing feature.
+ *
+ * It registers the `'selectAll'` {@link module:select-all/selectallcommand~SelectAllCommand command}
+ * and the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke listener which executes it.
+ */
+export default class SelectAllEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'SelectAllEditing';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [SelectAllEditing.pluginName]: SelectAllEditing;
+    }
+}

package/src/selectallediting.js

@@ -14,8 +14,6 @@ const SELECT_ALL_KEYSTROKE = parseKeystroke('Ctrl+A');
  *
  * It registers the `'selectAll'` {@link module:select-all/selectallcommand~SelectAllCommand command}
  * and the <kbd>Ctrl/⌘</kbd>+<kbd>A</kbd> keystroke listener which executes it.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class SelectAllEditing extends Plugin {
     /**

package/src/selectallui.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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 select-all/selectallui
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The select all UI feature.
+ *
+ * It registers the `'selectAll'` UI button in the editor's
+ * {@link module:ui/componentfactory~ComponentFactory component factory}. When clicked, the button
+ * executes the {@link module:select-all/selectallcommand~SelectAllCommand select all command}.
+ */
+export default class SelectAllUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'SelectAllUI';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [SelectAllUI.pluginName]: SelectAllUI;
+    }
+}

package/src/selectallui.js

@@ -14,8 +14,6 @@ import selectAllIcon from '../theme/icons/select-all.svg';
  * It registers the `'selectAll'` UI button in the editor's
  * {@link module:ui/componentfactory~ComponentFactory component factory}. When clicked, the button
  * executes the {@link module:select-all/selectallcommand~SelectAllCommand select all command}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class SelectAllUI extends Plugin {
     /**