Merge pull request #13566 from ckeditor/ck/13565-improving-module-aug…

…mentation-for-image-plugin Internal (image): Improve module augmentation in image plugin. Related to #13565.
ckeditor · Mar 7, 2023 · d2982b4 · d2982b4
2 parents f7ceda5 + 36ab485
commit d2982b4
Show file tree

Hide file tree

Showing 48 changed files with 127 additions and 278 deletions.
diff --git a/packages/ckeditor5-build-balloon-block/src/ckeditor.ts b/packages/ckeditor5-build-balloon-block/src/ckeditor.ts
@@ -16,18 +16,13 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import Link from '@ckeditor/ckeditor5-link/src/link';
 import List from '@ckeditor/ckeditor5-list/src/list';
 import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
 import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-balloon/src/ckeditor.ts b/packages/ckeditor5-build-balloon/src/ckeditor.ts
@@ -15,18 +15,13 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import Link from '@ckeditor/ckeditor5-link/src/link';
 import List from '@ckeditor/ckeditor5-list/src/list';
 import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
 import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-classic/src/ckeditor.ts b/packages/ckeditor5-build-classic/src/ckeditor.ts
@@ -15,18 +15,13 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import Link from '@ckeditor/ckeditor5-link/src/link';
 import List from '@ckeditor/ckeditor5-list/src/list';
 import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
 import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts b/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts
@@ -17,12 +17,7 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageResize from '@ckeditor/ckeditor5-image/src/imageresize';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageResize, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';
 import Link from '@ckeditor/ckeditor5-link/src/link';
@@ -31,7 +26,6 @@ import ListProperties from '@ckeditor/ckeditor5-list/src/listproperties';
 import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
 import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-inline/src/ckeditor.ts b/packages/ckeditor5-build-inline/src/ckeditor.ts
@@ -15,18 +15,13 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import Indent from '@ckeditor/ckeditor5-indent/src/indent';
 import Link from '@ckeditor/ckeditor5-link/src/link';
 import List from '@ckeditor/ckeditor5-list/src/list';
 import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
 import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-editor-multi-root/tsconfig.json b/packages/ckeditor5-editor-multi-root/tsconfig.json
@@ -1,10 +1,10 @@
 {
   "extends": "../../tsconfig.release.json",
   "include": [
-    "./src/",
-    "../../typings/"
+    "src",
+    "../../typings"
   ],
   "exclude": [
-    "./tests/"
+    "tests"
   ]
 }
diff --git a/packages/ckeditor5-image/src/augmentation.ts b/packages/ckeditor5-image/src/augmentation.ts
@@ -0,0 +1,99 @@
+/**
+ * @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 {
+	ImageConfig,
+
+	AutoImage,
+	Image,
+	ImageBlock,
+	ImageCaption,
+	ImageInline,
+	ImageInsert,
+	ImageInsertViaUrl,
+	ImageResize,
+	ImageStyle,
+	ImageTextAlternative,
+	ImageToolbar,
+	ImageUpload,
+	ImageUtils,
+	ImageBlockEditing,
+	ImageEditing,
+	ImageCaptionEditing,
+	ImageCaptionUI,
+	ImageCaptionUtils,
+	ImageInsertUI,
+	ImageResizeEditing,
+	ImageStyleEditing,
+	ImageStyleUI,
+	ImageTextAlternativeEditing,
+	ImageTextAlternativeUI,
+	ImageUploadEditing,
+	ImageUploadProgress,
+	ImageUploadUI,
+
+	ImageTypeCommand,
+	InsertImageCommand,
+	ReplaceImageSourceCommand,
+	ToggleImageCaptionCommand,
+	ResizeImageCommand,
+	ImageStyleCommand,
+	ImageTextAlternativeCommand,
+	UploadImageCommand
+} from '.';
+
+declare module '@ckeditor/ckeditor5-core' {
+  interface EditorConfig {
+
+		/**
+		 * The configuration of the image features. Used by the image features in the `@ckeditor/ckeditor5-image` package.
+		 *
+		 * Read more in {@link module:image/imageconfig~ImageConfig}.
+		 */
+		image?: ImageConfig;
+	}
+
+	interface PluginsMap {
+		[ AutoImage.pluginName ]: AutoImage;
+		[ Image.pluginName ]: Image;
+		[ ImageBlock.pluginName ]: ImageBlock;
+		[ ImageCaption.pluginName ]: ImageCaption;
+		[ ImageInline.pluginName ]: ImageInline;
+		[ ImageInsert.pluginName ]: ImageInsert;
+		[ ImageInsertViaUrl.pluginName ]: ImageInsertViaUrl;
+		[ ImageResize.pluginName ]: ImageResize;
+		[ ImageStyle.pluginName ]: ImageStyle;
+		[ ImageTextAlternative.pluginName ]: ImageTextAlternative;
+		[ ImageToolbar.pluginName ]: ImageToolbar;
+		[ ImageUpload.pluginName ]: ImageUpload;
+		[ ImageUtils.pluginName ]: ImageUtils;
+		[ ImageBlockEditing.pluginName ]: ImageBlockEditing;
+		[ ImageEditing.pluginName ]: ImageEditing;
+		[ ImageCaptionEditing.pluginName ]: ImageCaptionEditing;
+		[ ImageCaptionUI.pluginName ]: ImageCaptionUI;
+		[ ImageCaptionUtils.pluginName ]: ImageCaptionUtils;
+		[ ImageInsertUI.pluginName ]: ImageInsertUI;
+		[ ImageResizeEditing.pluginName ]: ImageResizeEditing;
+		[ ImageStyleEditing.pluginName ]: ImageStyleEditing;
+		[ ImageStyleUI.pluginName ]: ImageStyleUI;
+		[ ImageTextAlternativeEditing.pluginName ]: ImageTextAlternativeEditing;
+		[ ImageTextAlternativeUI.pluginName ]: ImageTextAlternativeUI;
+		[ ImageUploadEditing.pluginName ]: ImageUploadEditing;
+		[ ImageUploadProgress.pluginName ]: ImageUploadProgress;
+		[ ImageUploadUI.pluginName ]: ImageUploadUI;
+	}
+
+  interface CommandsMap {
+		imageTypeBlock: ImageTypeCommand;
+		imageTypeInline: ImageTypeCommand;
+		insertImage: InsertImageCommand;
+		replaceImageSource: ReplaceImageSourceCommand;
+		toggleImageCaption: ToggleImageCaptionCommand;
+		resizeImage: ResizeImageCommand;
+		imageStyle: ImageStyleCommand;
+		imageTextAlternative: ImageTextAlternativeCommand;
+		uploadImage: UploadImageCommand;
+	}
+}
diff --git a/packages/ckeditor5-image/src/autoimage.ts b/packages/ckeditor5-image/src/autoimage.ts
@@ -177,9 +177,3 @@ export default class AutoImage extends Plugin {
 		}, 100 );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ AutoImage.pluginName ]: AutoImage;
-	}
-}
diff --git a/packages/ckeditor5-image/src/image.ts b/packages/ckeditor5-image/src/image.ts
@@ -12,7 +12,6 @@ import ImageBlock from './imageblock';
 import ImageInline from './imageinline';
 
 import '../theme/image.css';
-import './imageconfig';
 
 /**
  * The image plugin.
@@ -42,10 +41,3 @@ export default class Image extends Plugin {
 		return 'Image';
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ Image.pluginName ]: Image;
-	}
-}
-
diff --git a/packages/ckeditor5-image/src/image/imageblockediting.ts b/packages/ckeditor5-image/src/image/imageblockediting.ts
@@ -176,9 +176,3 @@ export default class ImageBlockEditing extends Plugin {
 			} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageBlockEditing.pluginName ]: ImageBlockEditing;
-	}
-}
diff --git a/packages/ckeditor5-image/src/image/imageediting.ts b/packages/ckeditor5-image/src/image/imageediting.ts
@@ -85,9 +85,3 @@ export default class ImageEditing extends Plugin {
 		editor.commands.add( 'imageInsert', insertImageCommand );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageEditing.pluginName ]: ImageEditing;
-	}
-}
diff --git a/packages/ckeditor5-image/src/image/imagetypecommand.ts b/packages/ckeditor5-image/src/image/imagetypecommand.ts
@@ -100,10 +100,3 @@ export default class ImageTypeCommand extends Command {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		imageTypeBlock: ImageTypeCommand;
-		imageTypeInline: ImageTypeCommand;
-	}
-}
diff --git a/packages/ckeditor5-image/src/image/insertimagecommand.ts b/packages/ckeditor5-image/src/image/insertimagecommand.ts
@@ -11,8 +11,6 @@ import { Command, type Editor } from 'ckeditor5/src/core';
 import { logWarning, toArray, type ArrayOrItem } from 'ckeditor5/src/utils';
 import type ImageUtils from '../imageutils';
 
-import '../imageconfig';
-
 /**
  * Insert image command.
  *
@@ -134,9 +132,3 @@ export default class InsertImageCommand extends Command {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		insertImage: InsertImageCommand;
-	}
-}
diff --git a/packages/ckeditor5-image/src/image/replaceimagesourcecommand.ts b/packages/ckeditor5-image/src/image/replaceimagesourcecommand.ts
@@ -50,9 +50,3 @@ export default class ReplaceImageSourceCommand extends Command {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		replaceImageSource: ReplaceImageSourceCommand;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imageblock.ts b/packages/ckeditor5-image/src/imageblock.ts
@@ -41,10 +41,3 @@ export default class ImageBlock extends Plugin {
 		return 'ImageBlock';
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageBlock.pluginName ]: ImageBlock;
-	}
-}
-
diff --git a/packages/ckeditor5-image/src/imagecaption.ts b/packages/ckeditor5-image/src/imagecaption.ts
@@ -33,9 +33,3 @@ export default class ImageCaption extends Plugin {
 		return 'ImageCaption';
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageCaption.pluginName ]: ImageCaption;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imagecaption/imagecaptionediting.ts b/packages/ckeditor5-image/src/imagecaption/imagecaptionediting.ts
@@ -272,9 +272,3 @@ export default class ImageCaptionEditing extends Plugin {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageCaptionEditing.pluginName ]: ImageCaptionEditing;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imagecaption/imagecaptionui.ts b/packages/ckeditor5-image/src/imagecaption/imagecaptionui.ts
@@ -75,9 +75,3 @@ export default class ImageCaptionUI extends Plugin {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageCaptionUI.pluginName ]: ImageCaptionUI;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imagecaption/imagecaptionutils.ts b/packages/ckeditor5-image/src/imagecaption/imagecaptionutils.ts
@@ -78,9 +78,3 @@ export default class ImageCaptionUtils extends Plugin {
 		return null;
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageCaptionUtils.pluginName ]: ImageCaptionUtils;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imagecaption/toggleimagecaptioncommand.ts b/packages/ckeditor5-image/src/imagecaption/toggleimagecaptioncommand.ts
@@ -168,9 +168,3 @@ export default class ToggleImageCaptionCommand extends Command {
 		writer.remove( captionElement );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		toggleImageCaption: ToggleImageCaptionCommand;
-	}
-}
diff --git a/packages/ckeditor5-image/src/imageconfig.ts b/packages/ckeditor5-image/src/imageconfig.ts
@@ -743,16 +743,3 @@ export interface ImageUploadConfig {
 	 */
 	types: Array<string>;
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface EditorConfig {
-
-		/**
-		 * The configuration of the image features. Used by the image features in the `@ckeditor/ckeditor5-image` package.
-		 *
-		 * Read more in {@link module:image/imageconfig~ImageConfig}.
-		 */
-		image?: ImageConfig;
-	}
-
-}
diff --git a/packages/ckeditor5-image/src/imageinline.ts b/packages/ckeditor5-image/src/imageinline.ts
@@ -41,10 +41,3 @@ export default class ImageInline extends Plugin {
 		return 'ImageInline';
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ ImageInline.pluginName ]: ImageInline;
-	}
-}
-