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

…mentation-for-packages Internal: Improve TypeScript module augmentation. See #13565.
ckeditor · Mar 6, 2023 · c773f82 · c773f82
2 parents c644395 + 1aad5f1
commit c773f82
Show file tree

Hide file tree

Showing 115 changed files with 566 additions and 642 deletions.
diff --git a/packages/ckeditor5-build-balloon-block/src/ckeditor.ts b/packages/ckeditor5-build-balloon-block/src/ckeditor.ts
@@ -12,10 +12,10 @@ import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { BlockToolbar } from '@ckeditor/ckeditor5-ui';
 import { Bold, Italic } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -30,7 +30,7 @@ import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefrom
 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/src/cloudservices';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 /**
  * @internal

diff --git a/packages/ckeditor5-build-balloon/src/ckeditor.ts b/packages/ckeditor5-build-balloon/src/ckeditor.ts
@@ -11,10 +11,10 @@ import { UploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
 import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { Bold, Italic } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -29,7 +29,7 @@ import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefrom
 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/src/cloudservices';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 export default class BalloonEditor extends BalloonEditorBase {}
 

diff --git a/packages/ckeditor5-build-classic/src/ckeditor.ts b/packages/ckeditor5-build-classic/src/ckeditor.ts
@@ -11,10 +11,10 @@ import { UploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
 import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { Bold, Italic } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -29,7 +29,7 @@ import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefrom
 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/src/cloudservices';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 export default class ClassicEditor extends ClassicEditorBase {}
 

diff --git a/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts b/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts
@@ -8,18 +8,15 @@ import DecoupledEditorBase from '@ckeditor/ckeditor5-editor-decoupled/src/decoup
 
 import { Essentials } from '@ckeditor/ckeditor5-essentials';
 import { Alignment } from '@ckeditor/ckeditor5-alignment';
-import FontSize from '@ckeditor/ckeditor5-font/src/fontsize';
-import FontFamily from '@ckeditor/ckeditor5-font/src/fontfamily';
-import FontColor from '@ckeditor/ckeditor5-font/src/fontcolor';
-import FontBackgroundColor from '@ckeditor/ckeditor5-font/src/fontbackgroundcolor';
+import { FontSize, FontFamily, FontColor, FontBackgroundColor } from '@ckeditor/ckeditor5-font';
 import { UploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
 import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { Bold, Italic, Strikethrough, Underline } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -37,7 +34,7 @@ import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefrom
 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/src/cloudservices';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 export default class DecoupledEditor extends DecoupledEditorBase {}
 

diff --git a/packages/ckeditor5-build-inline/src/ckeditor.ts b/packages/ckeditor5-build-inline/src/ckeditor.ts
@@ -11,10 +11,10 @@ import { UploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
 import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { Bold, Italic } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -29,7 +29,7 @@ import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefrom
 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/src/cloudservices';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 export default class InlineEditor extends InlineEditorBase {}
 

diff --git a/packages/ckeditor5-build-multi-root/src/ckeditor.ts b/packages/ckeditor5-build-multi-root/src/ckeditor.ts
@@ -11,10 +11,10 @@ import { UploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
 import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
 import { Bold, Italic } from '@ckeditor/ckeditor5-basic-styles';
 import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
-import CKBox from '@ckeditor/ckeditor5-ckbox/src/ckbox';
-import CKFinder from '@ckeditor/ckeditor5-ckfinder/src/ckfinder';
-import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
-import Heading from '@ckeditor/ckeditor5-heading/src/heading';
+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';
@@ -28,8 +28,8 @@ 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/src/texttransformation';
-import CloudServices from '@ckeditor/ckeditor5-cloud-services/src/cloudservices';
+import { TextTransformation } from '@ckeditor/ckeditor5-typing';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
 
 export default class MultiRootEditor extends MultiRootEditorBase {}
 

diff --git a/packages/ckeditor5-ckbox/src/augmentation.ts b/packages/ckeditor5-ckbox/src/augmentation.ts
@@ -0,0 +1,32 @@
+/**
+ * @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 {
+	CKBox,
+	CKBoxCommand,
+	CKBoxConfig,
+	CKBoxEditing
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+
+		/**
+		 * The configuration of the {@link module:ckbox/ckbox~CKBox CKBox feature}.
+		 *
+		 * Read more in {@link module:ckbox/ckboxconfig~CKBoxConfig}.
+		 */
+		ckbox?: CKBoxConfig;
+	}
+
+	interface PluginsMap {
+		[ CKBox.pluginName ]: CKBox;
+		[ CKBoxEditing.pluginName ]: CKBoxEditing;
+	}
+
+	interface CommandsMap {
+		ckbox: CKBoxCommand;
+	}
+}
diff --git a/packages/ckeditor5-ckbox/src/ckbox.ts b/packages/ckeditor5-ckbox/src/ckbox.ts
@@ -40,10 +40,3 @@ export default class CKBox extends Plugin {
 		return [ CKBoxEditing, CKBoxUI ];
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-
-	interface PluginsMap {
-		[ CKBox.pluginName ]: CKBox;
-	}
-}
diff --git a/packages/ckeditor5-ckbox/src/ckboxcommand.ts b/packages/ckeditor5-ckbox/src/ckboxcommand.ts
@@ -425,9 +425,3 @@ type CKBoxEvent<Name extends '' | 'choose' | 'open' | 'close' = ''> = {
 	name: Name extends '' ? 'ckbox' : `ckbox:${ Name }`;
 	args: Name extends 'choose' ? [ assets: Array<CKBoxRawAssetDefinition> ] : [];
 };
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		ckbox: CKBoxCommand;
-	}
-}
diff --git a/packages/ckeditor5-ckbox/src/ckboxconfig.ts b/packages/ckeditor5-ckbox/src/ckboxconfig.ts
@@ -116,18 +116,6 @@ export interface CKBoxConfig {
 	language?: string;
 }
 
-declare module '@ckeditor/ckeditor5-core' {
-	interface EditorConfig {
-
-		/**
-		 * The configuration of the {@link module:ckbox/ckbox~CKBox CKBox feature}.
-		 *
-		 * Read more in {@link module:ckbox/ckboxconfig~CKBoxConfig}.
-		 */
-		ckbox?: CKBoxConfig;
-	}
-}
-
 /**
  * Asset definition.
  *

diff --git a/packages/ckeditor5-ckbox/src/ckboxediting.ts b/packages/ckeditor5-ckbox/src/ckboxediting.ts
@@ -335,12 +335,6 @@ export default class CKBoxEditing extends Plugin {
 	}
 }
 
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ CKBoxEditing.pluginName ]: CKBoxEditing;
-	}
-}
-
 /**
  * A post-fixer that synchronizes the asset ID with the model element.
  */

diff --git a/packages/ckeditor5-ckbox/src/ckboxuploadadapter.ts b/packages/ckeditor5-ckbox/src/ckboxuploadadapter.ts
@@ -24,8 +24,6 @@ import { logError } from 'ckeditor5/src/utils';
 import CKBoxEditing from './ckboxediting';
 import { getImageUrls } from './utils';
 
-import './ckboxconfig';
-
 /**
  * A plugin that enables file uploads in CKEditor 5 using the CKBox server–side connector.
  * See the {@glink features/images/image-upload/ckbox CKBox file manager integration} guide to learn how to configure

diff --git a/packages/ckeditor5-ckbox/src/index.ts b/packages/ckeditor5-ckbox/src/index.ts
@@ -10,3 +10,7 @@
 export { default as CKBox } from './ckbox';
 export { default as CKBoxEditing } from './ckboxediting';
 export { default as CKBoxUI } from './ckboxui';
+export type { default as CKBoxCommand } from './ckboxcommand';
+export type { CKBoxConfig } from './ckboxconfig';
+
+import './augmentation';
diff --git a/packages/ckeditor5-ckfinder/src/augmentation.ts b/packages/ckeditor5-ckfinder/src/augmentation.ts
@@ -0,0 +1,32 @@
+/**
+ * @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 {
+	CKFinder,
+	CKFinderCommand,
+	CKFinderConfig,
+	CKFinderEditing
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+
+		/**
+		 * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}.
+		 *
+		 * Read more in {@link module:ckfinder/ckfinderconfig~CKFinderConfig}.
+		 */
+		ckfinder?: CKFinderConfig;
+	}
+
+	interface PluginsMap {
+		[ CKFinder.pluginName ]: CKFinder;
+		[ CKFinderEditing.pluginName ]: CKFinderEditing;
+	}
+
+	interface CommandsMap {
+		ckfinder: CKFinderCommand;
+	}
+}
diff --git a/packages/ckeditor5-ckfinder/src/ckfinder.ts b/packages/ckeditor5-ckfinder/src/ckfinder.ts
@@ -43,9 +43,3 @@ export default class CKFinder extends Plugin {
 		return [ 'Link', 'CKFinderUploadAdapter', CKFinderEditing, CKFinderUI ];
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ CKFinder.pluginName ]: CKFinder;
-	}
-}
diff --git a/packages/ckeditor5-ckfinder/src/ckfindercommand.ts b/packages/ckeditor5-ckfinder/src/ckfindercommand.ts
@@ -13,8 +13,6 @@ import { Command, type Editor } from 'ckeditor5/src/core';
 import { CKEditorError } from 'ckeditor5/src/utils';
 import type { Notification } from 'ckeditor5/src/ui';
 
-import './ckfinderconfig';
-
 /**
  * The CKFinder command. It is used by the {@link module:ckfinder/ckfinderediting~CKFinderEditing CKFinder editing feature}
  * to open the CKFinder file manager to insert an image or a link to a file into the editor content.
@@ -158,9 +156,3 @@ function insertImages( editor: Editor, urls: Array<string> ): void {
 
 	editor.execute( 'insertImage', { source: urls } );
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		ckfinder: CKFinderCommand;
-	}
-}
diff --git a/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts b/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts
@@ -77,15 +77,3 @@ export interface CKFinderOptions extends Record<string, unknown> {
 	onInit?: ( finder: any ) => void;
 	language?: string;
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface EditorConfig {
-
-		/**
-		 * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}.
-		 *
-		 * Read more in {@link module:ckfinder/ckfinderconfig~CKFinderConfig}.
-		 */
-		ckfinder?: CKFinderConfig;
-	}
-}
diff --git a/packages/ckeditor5-ckfinder/src/ckfinderediting.ts b/packages/ckeditor5-ckfinder/src/ckfinderediting.ts
@@ -56,9 +56,3 @@ export default class CKFinderEditing extends Plugin {
 		editor.commands.add( 'ckfinder', new CKFinderCommand( editor ) );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ CKFinderEditing.pluginName ]: CKFinderEditing;
-	}
-}
diff --git a/packages/ckeditor5-ckfinder/src/index.ts b/packages/ckeditor5-ckfinder/src/index.ts
@@ -11,3 +11,6 @@ export { default as CKFinder } from './ckfinder';
 export { default as CKFinderEditing } from './ckfinderediting';
 export { default as CKFinderUI } from './ckfinderui';
 export type { CKFinderConfig } from './ckfinderconfig';
+export type { default as CKFinderCommand } from './ckfindercommand';
+
+import './augmentation';
diff --git a/packages/ckeditor5-cloud-services/src/augmentation.ts b/packages/ckeditor5-cloud-services/src/augmentation.ts
@@ -0,0 +1,27 @@
+/**
+ * @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 {
+	CloudServices,
+	CloudServicesConfig,
+	CloudServicesCore
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+
+		/**
+		 * The configuration of CKEditor Cloud Services. Introduced by the {@link module:cloud-services/cloudservices~CloudServices} plugin.
+		 *
+		 * Read more in {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig}.
+		 */
+		cloudServices?: CloudServicesConfig;
+	}
+
+	interface PluginsMap {
+		[ CloudServices.pluginName ]: CloudServices;
+		[ CloudServicesCore.pluginName ]: CloudServicesCore;
+	}
+}
diff --git a/packages/ckeditor5-cloud-services/src/cloudservices.ts b/packages/ckeditor5-cloud-services/src/cloudservices.ts
@@ -152,9 +152,3 @@ export default class CloudServices extends ContextPlugin implements CloudService
 		}
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ CloudServices.pluginName ]: CloudServices;
-	}
-}