@ckeditor/ckeditor5-image 48.2.0 → 48.3.0-alpha.1

package/dist/augmentation.d.ts

@@ -1,57 +1,57 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { ImageConfig, AutoImage, Image, ImageBlock, ImageCaption, ImageInline, ImageInsert, ImageInsertViaUrl, ImageResize, ImageStyle, ImageTextAlternative, ImageToolbar, ImageUpload, ImageUtils, ImageBlockEditing, ImageEditing, ImageCaptionEditing, ImageCaptionUI, ImageCaptionUtils, ImageInsertUI, ImageResizeEditing, ImageCustomResizeUI, ImageSizeAttributes, ImageStyleEditing, ImageStyleUI, ImageTextAlternativeEditing, ImageTextAlternativeUI, ImageUploadEditing, ImageUploadProgress, ImageUploadUI, ImageTypeCommand, InsertImageCommand, ReplaceImageSourceCommand, ToggleImageCaptionCommand, ResizeImageCommand, ImageStyleCommand, ImageTextAlternativeCommand, UploadImageCommand } from './index.js';
-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;
-        [ImageCustomResizeUI.pluginName]: ImageCustomResizeUI;
-        [ImageSizeAttributes.pluginName]: ImageSizeAttributes;
-        [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;
-    }
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import type { ImageConfig, AutoImage, Image, ImageBlock, ImageCaption, ImageInline, ImageInsert, ImageInsertViaUrl, ImageResize, ImageStyle, ImageTextAlternative, ImageToolbar, ImageUpload, ImageUtils, ImageBlockEditing, ImageEditing, ImageCaptionEditing, ImageCaptionUI, ImageCaptionUtils, ImageInsertUI, ImageResizeEditing, ImageCustomResizeUI, ImageSizeAttributes, ImageStyleEditing, ImageStyleUI, ImageTextAlternativeEditing, ImageTextAlternativeUI, ImageUploadEditing, ImageUploadProgress, ImageUploadUI, ImageTypeCommand, InsertImageCommand, ReplaceImageSourceCommand, ToggleImageCaptionCommand, ResizeImageCommand, ImageStyleCommand, ImageTextAlternativeCommand, UploadImageCommand } from "./index.js";
+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;
+		[ImageCustomResizeUI.pluginName]: ImageCustomResizeUI;
+		[ImageSizeAttributes.pluginName]: ImageSizeAttributes;
+		[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;
+	}
 }

package/dist/autoimage.d.ts

@@ -1,56 +1,56 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/autoimage
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { Clipboard } from '@ckeditor/ckeditor5-clipboard';
-import { Undo } from '@ckeditor/ckeditor5-undo';
-import { Delete } from '@ckeditor/ckeditor5-typing';
-import { ImageUtils } from './imageutils.js';
+* @module image/autoimage
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Clipboard } from "@ckeditor/ckeditor5-clipboard";
+import { Undo } from "@ckeditor/ckeditor5-undo";
+import { Delete } from "@ckeditor/ckeditor5-typing";
+import { ImageUtils } from "./imageutils.js";
 /**
- * The auto-image plugin. It recognizes image links in the pasted content and embeds
- * them shortly after they are injected into the document.
- */
+* The auto-image plugin. It recognizes image links in the pasted content and embeds
+* them shortly after they are injected into the document.
+*/
 export declare class AutoImage extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Clipboard, typeof ImageUtils, typeof Undo, typeof Delete];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AutoImage";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * The paste–to–embed `setTimeout` ID. Stored as a property to allow
-     * cleaning of the timeout.
-     */
-    private _timeoutId;
-    /**
-     * The position where the `<imageBlock>` element will be inserted after the timeout,
-     * determined each time a new content is pasted into the document.
-     */
-    private _positionToInsert;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Analyzes the part of the document between provided positions in search for a URL representing an image.
-     * When the URL is found, it is automatically converted into an image.
-     *
-     * @param leftPosition Left position of the selection.
-     * @param rightPosition Right position of the selection.
-     */
-    private _embedImageBetweenPositions;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Clipboard, ImageUtils, Undo, Delete]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "AutoImage";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* The paste–to–embed `setTimeout` ID. Stored as a property to allow
+	* cleaning of the timeout.
+	*/
+	private _timeoutId;
+	/**
+	* The position where the `<imageBlock>` element will be inserted after the timeout,
+	* determined each time a new content is pasted into the document.
+	*/
+	private _positionToInsert;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Analyzes the part of the document between provided positions in search for a URL representing an image.
+	* When the URL is found, it is automatically converted into an image.
+	*
+	* @param leftPosition Left position of the selection.
+	* @param rightPosition Right position of the selection.
+	*/
+	private _embedImageBetweenPositions;
 }

package/dist/image/converters.d.ts

@@ -1,66 +1,88 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/converters
- */
-import type { DowncastDispatcher, UpcastDispatcher } from '@ckeditor/ckeditor5-engine';
-import { type ImageUtils } from '../imageutils.js';
+* @module image/image/converters
+*/
+import { type DowncastDispatcher, type UpcastDispatcher } from "@ckeditor/ckeditor5-engine";
+import { type ImageUtils } from "../imageutils.js";
 /**
- * Returns a function that converts the image view representation:
- *
- * ```html
- * <figure class="image"><img src="..." alt="..."></img></figure>
- * ```
- *
- * to the model representation:
- *
- * ```html
- * <imageBlock src="..." alt="..."></imageBlock>
- * ```
- *
- * The entire content of the `<figure>` element except the first `<img>` is being converted as children
- * of the `<imageBlock>` model element.
- *
- * @internal
- */
+* Returns a function that converts the image view representation:
+*
+* ```html
+* <figure class="image"><img src="..." alt="..."></img></figure>
+* ```
+*
+* to the model representation:
+*
+* ```html
+* <imageBlock src="..." alt="..."></imageBlock>
+* ```
+*
+* The entire content of the `<figure>` element except the first `<img>` is being converted as children
+* of the `<imageBlock>` model element.
+*
+* @internal
+*/
 export declare function upcastImageFigure(imageUtils: ImageUtils): (dispatcher: UpcastDispatcher) => void;
 /**
- * Returns a function that converts the image view representation:
- *
- * ```html
- * <picture><source ... /><source ... />...<img ... /></picture>
- * ```
- *
- * to the model representation as the `sources` attribute:
- *
- * ```html
- * <image[Block|Inline] ... sources="..."></image[Block|Inline]>
- * ```
- *
- * @internal
- */
+* Returns a function that upcasts an `<img>` element to either an `imageBlock` or an `imageInline` model element.
+*
+* The image type is first determined from the view structure (see {@link module:image/image/utils~getViewImageType}):
+* an `<img>` wrapped in a `<figure class="image">` or styled with `display: block` becomes an `imageBlock`, otherwise
+* an `imageInline`.
+*
+* That structural type is then verified against the schema at the insertion position. If it cannot be placed there -
+* neither directly (or after hoisting to an allowed ancestor) nor wrapped in an auto-created paragraph - the converter
+* falls back to `matchImageType`. This is what allows a block image to degrade to an inline image inside an inline root
+* (and, symmetrically, an inline image to become a block image in a context that only accepts block images) instead of
+* being dropped.
+*
+* Both `ImageBlockEditing` and `ImageInlineEditing` register this converter, each passing the type it falls back to.
+* When only one of them is loaded, that single type is always produced.
+*
+* @internal
+* @param matchImageType The image type to fall back to when the type resolved from the view cannot be placed at the
+* insertion position.
+* @param imageUtils The `ImageUtils` plugin instance.
+*/
+export declare function upcastImg(matchImageType: "imageBlock" | "imageInline", imageUtils: ImageUtils): (dispatcher: UpcastDispatcher) => void;
+/**
+* Returns a function that converts the image view representation:
+*
+* ```html
+* <picture><source ... /><source ... />...<img ... /></picture>
+* ```
+*
+* to the model representation as the `sources` attribute:
+*
+* ```html
+* <image[Block|Inline] ... sources="..."></image[Block|Inline]>
+* ```
+*
+* @internal
+*/
 export declare function upcastPicture(imageUtils: ImageUtils): (dispatcher: UpcastDispatcher) => void;
 /**
- * Converter used to convert the `srcset` model image attribute to the `srcset` and `sizes` attributes in the view.
- *
- * @internal
- * @param imageType The type of the image.
- */
-export declare function downcastSrcsetAttribute(imageUtils: ImageUtils, imageType: 'imageBlock' | 'imageInline'): (dispatcher: DowncastDispatcher) => void;
+* Converter used to convert the `srcset` model image attribute to the `srcset` and `sizes` attributes in the view.
+*
+* @internal
+* @param imageType The type of the image.
+*/
+export declare function downcastSrcsetAttribute(imageUtils: ImageUtils, imageType: "imageBlock" | "imageInline"): (dispatcher: DowncastDispatcher) => void;
 /**
- * Converts the `source` model attribute to the `<picture><source /><source />...<img /></picture>`
- * view structure.
- *
- * @internal
- */
+* Converts the `source` model attribute to the `<picture><source /><source />...<img /></picture>`
+* view structure.
+*
+* @internal
+*/
 export declare function downcastSourcesAttribute(imageUtils: ImageUtils): (dispatcher: DowncastDispatcher) => void;
 /**
- * Converter used to convert a given image attribute from the model to the view.
- *
- * @internal
- * @param imageType The type of the image.
- * @param attributeKey The name of the attribute to convert.
- */
-export declare function downcastImageAttribute(imageUtils: ImageUtils, imageType: 'imageBlock' | 'imageInline', attributeKey: string): (dispatcher: DowncastDispatcher) => void;
+* Converter used to convert a given image attribute from the model to the view.
+*
+* @internal
+* @param imageType The type of the image.
+* @param attributeKey The name of the attribute to convert.
+*/
+export declare function downcastImageAttribute(imageUtils: ImageUtils, imageType: "imageBlock" | "imageInline", attributeKey: string): (dispatcher: DowncastDispatcher) => void;

package/dist/image/imageblockediting.d.ts

@@ -1,63 +1,63 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imageblockediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
-import { ImageEditing } from './imageediting.js';
-import { ImageSizeAttributes } from '../imagesizeattributes.js';
-import { ImageUtils } from '../imageutils.js';
-import { ImagePlaceholder } from './imageplaceholder.js';
+* @module image/image/imageblockediting
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ClipboardPipeline } from "@ckeditor/ckeditor5-clipboard";
+import { ImageEditing } from "./imageediting.js";
+import { ImageSizeAttributes } from "../imagesizeattributes.js";
+import { ImageUtils } from "../imageutils.js";
+import { ImagePlaceholder } from "./imageplaceholder.js";
 /**
- * The image block plugin.
- *
- * It registers:
- *
- * * `<imageBlock>` as a block element in the document schema, and allows `alt`, `src` and `srcset` attributes.
- * * converters for editing and data pipelines.,
- * * {@link module:image/image/imagetypecommand~ImageTypeCommand `'imageTypeBlock'`} command that converts inline images into
- * block images.
- */
+* The image block plugin.
+*
+* It registers:
+*
+* * `<imageBlock>` as a block element in the document schema, and allows `alt`, `src` and `srcset` attributes.
+* * converters for editing and data pipelines.,
+* * {@link module:image/image/imagetypecommand~ImageTypeCommand `'imageTypeBlock'`} command that converts inline images into
+* block images.
+*/
 export declare class ImageBlockEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageEditing, typeof ImageSizeAttributes, typeof ImageUtils, typeof ImagePlaceholder, typeof ClipboardPipeline];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageBlockEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Configures conversion pipelines to support upcasting and downcasting
-     * block images (block image widgets) and their attributes.
-     */
-    private _setupConversion;
-    /**
-     * Integrates the plugin with the clipboard pipeline.
-     *
-     * Idea is that the feature should recognize the user's intent when an **inline** image is
-     * pasted or dropped. If such an image is pasted/dropped:
-     *
-     * * into an empty block (e.g. an empty paragraph),
-     * * on another object (e.g. some block widget).
-     *
-     * it gets converted into a block image on the fly. We assume this is the user's intent
-     * if they decided to put their image there.
-     *
-     * See the `ImageInlineEditing` for the similar integration that works in the opposite direction.
-     *
-     * The feature also sets image `width` and `height` attributes on paste.
-     */
-    private _setupClipboardIntegration;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageEditing, ImageSizeAttributes, ImageUtils, ImagePlaceholder, ClipboardPipeline]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageBlockEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Configures conversion pipelines to support upcasting and downcasting
+	* block images (block image widgets) and their attributes.
+	*/
+	private _setupConversion;
+	/**
+	* Integrates the plugin with the clipboard pipeline.
+	*
+	* Idea is that the feature should recognize the user's intent when an **inline** image is
+	* pasted or dropped. If such an image is pasted/dropped:
+	*
+	* * into an empty block (e.g. an empty paragraph),
+	* * on another object (e.g. some block widget).
+	*
+	* it gets converted into a block image on the fly. We assume this is the user's intent
+	* if they decided to put their image there.
+	*
+	* See the `ImageInlineEditing` for the similar integration that works in the opposite direction.
+	*
+	* The feature also sets image `width` and `height` attributes on paste.
+	*/
+	private _setupClipboardIntegration;
 }

package/dist/image/imageediting.d.ts

@@ -1,34 +1,34 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imageediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ImageUtils } from '../imageutils.js';
+* @module image/image/imageediting
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ImageUtils } from "../imageutils.js";
 /**
- * The image engine plugin. This module loads common code shared between
- * {@link module:image/image/imageinlineediting~ImageInlineEditing} and
- * {@link module:image/image/imageblockediting~ImageBlockEditing} plugins.
- *
- * This plugin registers the {@link module:image/image/insertimagecommand~InsertImageCommand 'insertImage'} command.
- */
+* The image engine plugin. This module loads common code shared between
+* {@link module:image/image/imageinlineediting~ImageInlineEditing} and
+* {@link module:image/image/imageblockediting~ImageBlockEditing} plugins.
+*
+* This plugin registers the {@link module:image/image/insertimagecommand~InsertImageCommand 'insertImage'} command.
+*/
 export declare class ImageEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageUtils]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }