@ckeditor/ckeditor5-image 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/imageupload/imageuploadediting.d.ts

@@ -1,130 +1,130 @@
 /**
- * @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/imageupload/imageuploadediting
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { type ModelElement, type ModelWriter, type ViewDataTransfer } from '@ckeditor/ckeditor5-engine';
-import { Notification } from '@ckeditor/ckeditor5-ui';
-import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
-import { FileRepository, type UploadResponse, type FileLoader } from '@ckeditor/ckeditor5-upload';
-import { ImageUtils } from '../imageutils.js';
+* @module image/imageupload/imageuploadediting
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type ModelElement, type ModelWriter, type ViewDataTransfer } from "@ckeditor/ckeditor5-engine";
+import { Notification } from "@ckeditor/ckeditor5-ui";
+import { ClipboardPipeline } from "@ckeditor/ckeditor5-clipboard";
+import { FileRepository, type UploadResponse, type FileLoader } from "@ckeditor/ckeditor5-upload";
+import { ImageUtils } from "../imageutils.js";
 /**
- * The editing part of the image upload feature. It registers the `'uploadImage'` command
- * and the `imageUpload` command as an aliased name.
- *
- * When an image is uploaded, it fires the {@link ~ImageUploadEditing#event:uploadComplete `uploadComplete`} event
- * that allows adding custom attributes to the {@link module:engine/model/element~ModelElement image element}.
- */
+* The editing part of the image upload feature. It registers the `'uploadImage'` command
+* and the `imageUpload` command as an aliased name.
+*
+* When an image is uploaded, it fires the {@link ~ImageUploadEditing#event:uploadComplete `uploadComplete`} event
+* that allows adding custom attributes to the {@link module:engine/model/element~ModelElement image element}.
+*/
 export declare class ImageUploadEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FileRepository, typeof Notification, typeof ClipboardPipeline, typeof ImageUtils];
-    static get pluginName(): "ImageUploadEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * An internal mapping of {@link module:upload/filerepository~FileLoader#id file loader UIDs} and
-     * model elements during the upload.
-     *
-     * Model element of the uploaded image can change, for instance, when {@link module:image/image/imagetypecommand~ImageTypeCommand}
-     * is executed as a result of adding caption or changing image style. As a result, the upload logic must keep track of the model
-     * element (reference) and resolve the upload for the correct model element (instead of the one that landed in the `$graveyard`
-     * after image type changed).
-     */
-    private readonly _uploadImageElements;
-    /**
-     * An internal mapping of {@link module:upload/filerepository~FileLoader#id file loader UIDs} and
-     * upload responses for handling images dragged during their upload process. When such images are later
-     * dropped, their original upload IDs no longer exist in the registry (as the original upload completed).
-     * This map preserves the upload responses to properly handle such cases.
-     */
-    private readonly _uploadedImages;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Reads and uploads an image.
-     *
-     * The image is read from the disk and as a Base64-encoded string it is set temporarily to
-     * `image[src]`. When the image is successfully uploaded, the temporary data is replaced with the target
-     * image's URL (the URL to the uploaded image on the server).
-     */
-    protected _readAndUpload(loader: FileLoader): Promise<void>;
-    /**
-     * Creates the `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element.
-     *
-     * @param data Data object from which `srcset` will be created.
-     * @param image The image element on which the `srcset` attribute will be set.
-     */
-    protected _parseAndSetSrcsetAttributeOnImage(data: Record<string, unknown>, image: ModelElement, writer: ModelWriter): void;
-    /**
-     * Registers image upload converters.
-     *
-     * @param imageType The type of the image.
-     */
-    private _registerConverters;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[FileRepository, Notification, ClipboardPipeline, ImageUtils]>;
+	static get pluginName(): "ImageUploadEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* An internal mapping of {@link module:upload/filerepository~FileLoader#id file loader UIDs} and
+	* model elements during the upload.
+	*
+	* Model element of the uploaded image can change, for instance, when {@link module:image/image/imagetypecommand~ImageTypeCommand}
+	* is executed as a result of adding caption or changing image style. As a result, the upload logic must keep track of the model
+	* element (reference) and resolve the upload for the correct model element (instead of the one that landed in the `$graveyard`
+	* after image type changed).
+	*/
+	private readonly _uploadImageElements;
+	/**
+	* An internal mapping of {@link module:upload/filerepository~FileLoader#id file loader UIDs} and
+	* upload responses for handling images dragged during their upload process. When such images are later
+	* dropped, their original upload IDs no longer exist in the registry (as the original upload completed).
+	* This map preserves the upload responses to properly handle such cases.
+	*/
+	private readonly _uploadedImages;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* Reads and uploads an image.
+	*
+	* The image is read from the disk and as a Base64-encoded string it is set temporarily to
+	* `image[src]`. When the image is successfully uploaded, the temporary data is replaced with the target
+	* image's URL (the URL to the uploaded image on the server).
+	*/
+	protected _readAndUpload(loader: FileLoader): Promise<void>;
+	/**
+	* Creates the `srcset` attribute based on a given file upload response and sets it as an attribute to a specific image element.
+	*
+	* @param data Data object from which `srcset` will be created.
+	* @param image The image element on which the `srcset` attribute will be set.
+	*/
+	protected _parseAndSetSrcsetAttributeOnImage(data: Record<string, unknown>, image: ModelElement, writer: ModelWriter): void;
+	/**
+	* Registers image upload converters.
+	*
+	* @param imageType The type of the image.
+	*/
+	private _registerConverters;
 }
 /**
- * TODO move this to the clipboard package.
- *
- * Returns `true` if non-empty `text/html` is included in the data transfer.
- */
+* TODO move this to the clipboard package.
+*
+* Returns `true` if non-empty `text/html` is included in the data transfer.
+*/
 export declare function isHtmlInDataTransfer(dataTransfer: ViewDataTransfer): boolean;
 /**
- * An event fired when an image is uploaded. You can hook into this event to provide
- * custom attributes to the {@link module:engine/model/element~ModelElement image element} based on the data from
- * the server.
- *
- * ```ts
- * const imageUploadEditing = editor.plugins.get( 'ImageUploadEditing' );
- *
- * imageUploadEditing.on( 'uploadComplete', ( evt, { data, imageElement } ) => {
- * 	editor.model.change( writer => {
- * 		writer.setAttribute( 'someAttribute', 'foo', imageElement );
- * 	} );
- * } );
- * ```
- *
- * You can also stop the default handler that sets the `src` and `srcset` attributes
- * if you want to provide custom values for these attributes.
- *
- * ```ts
- * imageUploadEditing.on( 'uploadComplete', ( evt, { data, imageElement } ) => {
- * 	evt.stop();
- * } );
- * ```
- *
- * **Note**: This event is fired by the {@link module:image/imageupload/imageuploadediting~ImageUploadEditing} plugin.
- *
- * @eventName ~ImageUploadEditing#uploadComplete
- * @param data The `uploadComplete` event data.
- */
+* An event fired when an image is uploaded. You can hook into this event to provide
+* custom attributes to the {@link module:engine/model/element~ModelElement image element} based on the data from
+* the server.
+*
+* ```ts
+* const imageUploadEditing = editor.plugins.get( 'ImageUploadEditing' );
+*
+* imageUploadEditing.on( 'uploadComplete', ( evt, { data, imageElement } ) => {
+* 	editor.model.change( writer => {
+* 		writer.setAttribute( 'someAttribute', 'foo', imageElement );
+* 	} );
+* } );
+* ```
+*
+* You can also stop the default handler that sets the `src` and `srcset` attributes
+* if you want to provide custom values for these attributes.
+*
+* ```ts
+* imageUploadEditing.on( 'uploadComplete', ( evt, { data, imageElement } ) => {
+* 	evt.stop();
+* } );
+* ```
+*
+* **Note**: This event is fired by the {@link module:image/imageupload/imageuploadediting~ImageUploadEditing} plugin.
+*
+* @eventName ~ImageUploadEditing#uploadComplete
+* @param data The `uploadComplete` event data.
+*/
 export type ImageUploadCompleteEvent = {
-    name: 'uploadComplete';
-    args: [data: ImageUploadCompleteData];
+	name: "uploadComplete";
+	args: [data: ImageUploadCompleteData];
 };
 export type ImageUploadCompleteData = {
-    /**
-     * The data coming from the upload adapter.
-     */
-    data: UploadResponse;
-    /**
-     * The model {@link module:engine/model/element~ModelElement image element} that can be customized.
-     */
-    imageElement: ModelElement;
+	/**
+	* The data coming from the upload adapter.
+	*/
+	data: UploadResponse;
+	/**
+	* The model {@link module:engine/model/element~ModelElement image element} that can be customized.
+	*/
+	imageElement: ModelElement;
 };

package/dist/imageupload/imageuploadprogress.d.ts

@@ -1,46 +1,46 @@
 /**
- * @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/imageupload/imageuploadprogress
- */
-import { type Editor, Plugin } from '@ckeditor/ckeditor5-core';
-import '../../theme/imageuploadprogress.css';
-import '../../theme/imageuploadicon.css';
-import '../../theme/imageuploadloader.css';
+* @module image/imageupload/imageuploadprogress
+*/
+import { type Editor, Plugin } from "@ckeditor/ckeditor5-core";
+import "../../theme/imageuploadprogress.css";
+import "../../theme/imageuploadicon.css";
+import "../../theme/imageuploadloader.css";
 /**
- * The image upload progress plugin.
- * It shows a placeholder when the image is read from the disk and a progress bar while the image is uploading.
- */
+* The image upload progress plugin.
+* It shows a placeholder when the image is read from the disk and a progress bar while the image is uploading.
+*/
 export declare class ImageUploadProgress extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageUploadProgress";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * The image placeholder that is displayed before real image data can be accessed.
-     *
-     * For the record, this image is a 1x1 px GIF with an aspect ratio set by CSS.
-     */
-    private placeholder;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * This method is called each time the image `uploadStatus` attribute is changed.
-     *
-     * @param evt An object containing information about the fired event.
-     * @param data Additional information about the change.
-     */
-    private uploadStatusChange;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageUploadProgress";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* The image placeholder that is displayed before real image data can be accessed.
+	*
+	* For the record, this image is a 1x1 px GIF with an aspect ratio set by CSS.
+	*/
+	private placeholder;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* This method is called each time the image `uploadStatus` attribute is changed.
+	*
+	* @param evt An object containing information about the fired event.
+	* @param data Additional information about the change.
+	*/
+	private uploadStatusChange;
 }

package/dist/imageupload/imageuploadui.d.ts

@@ -1,51 +1,51 @@
 /**
- * @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/imageupload/imageuploadui
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module image/imageupload/imageuploadui
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * The image upload button plugin.
- *
- * For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature} documentation.
- *
- * Adds the `'uploadImage'` button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
- * and also the `imageUpload` button as an alias for backward compatibility.
- *
- * Adds the `'menuBar:uploadImage'` menu button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}.
- *
- * It also integrates with the `insertImage` toolbar component and `menuBar:insertImage` menu component, which are the default components
- * through which image upload is available.
- */
+* The image upload button plugin.
+*
+* For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature} documentation.
+*
+* Adds the `'uploadImage'` button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
+* and also the `imageUpload` button as an alias for backward compatibility.
+*
+* Adds the `'menuBar:uploadImage'` menu button to the {@link module:ui/componentfactory~ComponentFactory UI component factory}.
+*
+* It also integrates with the `insertImage` toolbar component and `menuBar:insertImage` menu component, which are the default components
+* through which image upload is available.
+*/
 export declare class ImageUploadUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageUploadUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates the base for various kinds of the button component provided by this feature.
-     */
-    private _createButton;
-    /**
-     * Creates a simple toolbar button, with an icon and a tooltip.
-     */
-    private _createToolbarButton;
-    /**
-     * Creates a button for the dropdown view, with an icon, text and no tooltip.
-     */
-    private _createDropdownButton;
-    /**
-     * Creates a button for the menu bar.
-     */
-    private _createMenuBarButton;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageUploadUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Creates the base for various kinds of the button component provided by this feature.
+	*/
+	private _createButton;
+	/**
+	* Creates a simple toolbar button, with an icon and a tooltip.
+	*/
+	private _createToolbarButton;
+	/**
+	* Creates a button for the dropdown view, with an icon, text and no tooltip.
+	*/
+	private _createDropdownButton;
+	/**
+	* Creates a button for the menu bar.
+	*/
+	private _createMenuBarButton;
 }

package/dist/imageupload/uploadimagecommand.d.ts

@@ -1,71 +1,71 @@
 /**
- * @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 { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
+* @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 { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import { type ArrayOrItem } from "@ckeditor/ckeditor5-utils";
 /**
- * The upload image command.
- *
- * The command is registered by the {@link module:image/imageupload/imageuploadediting~ImageUploadEditing} plugin as `uploadImage`
- * and it is also available via aliased `imageUpload` name.
- *
- * In order to upload an image at the current selection position
- * (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
- * execute the command and pass the native image file instance:
- *
- * ```ts
- * this.listenTo( editor.editing.view.document, 'clipboardInput', ( evt, data ) => {
- * 	// Assuming that only images were pasted:
- * 	const images = Array.from( data.dataTransfer.files );
- *
- * 	// Upload the first image:
- * 	editor.execute( 'uploadImage', { file: images[ 0 ] } );
- * } );
- * ```
- *
- * It is also possible to insert multiple images at once:
- *
- * ```ts
- * editor.execute( 'uploadImage', {
- * 	file: [
- * 		file1,
- * 		file2
- * 	]
- * } );
- * ```
- */
+* The upload image command.
+*
+* The command is registered by the {@link module:image/imageupload/imageuploadediting~ImageUploadEditing} plugin as `uploadImage`
+* and it is also available via aliased `imageUpload` name.
+*
+* In order to upload an image at the current selection position
+* (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
+* execute the command and pass the native image file instance:
+*
+* ```ts
+* this.listenTo( editor.editing.view.document, 'clipboardInput', ( evt, data ) => {
+* 	// Assuming that only images were pasted:
+* 	const images = Array.from( data.dataTransfer.files );
+*
+* 	// Upload the first image:
+* 	editor.execute( 'uploadImage', { file: images[ 0 ] } );
+* } );
+* ```
+*
+* It is also possible to insert multiple images at once:
+*
+* ```ts
+* editor.execute( 'uploadImage', {
+* 	file: [
+* 		file1,
+* 		file2
+* 	]
+* } );
+* ```
+*/
 export declare class UploadImageCommand extends Command {
-    /**
-     * The command property: `false` if there is no permission on image upload, otherwise `true`.
-     *
-     * @observable
-     * @internal
-     */
-    isAccessAllowed: boolean;
-    /**
-     * Creates an instance of the `imageUlpoad` command. When executed, the command upload one of
-     * the currently selected image from computer.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Options for the executed command.
-     * @param options.file The image file or an array of image files to upload.
-     */
-    execute(options: {
-        file: ArrayOrItem<File>;
-    }): void;
-    /**
-     * Handles uploading single file.
-     */
-    private _uploadImage;
+	/**
+	* The command property: `false` if there is no permission on image upload, otherwise `true`.
+	*
+	* @observable
+	* @internal
+	*/
+	isAccessAllowed: boolean;
+	/**
+	* Creates an instance of the `imageUlpoad` command. When executed, the command upload one of
+	* the currently selected image from computer.
+	*
+	* @param editor The editor instance.
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @fires execute
+	* @param options Options for the executed command.
+	* @param options.file The image file or an array of image files to upload.
+	*/
+	override execute(options: {
+		file: ArrayOrItem<File>;
+	}): void;
+	/**
+	* Handles uploading single file.
+	*/
+	private _uploadImage;
 }

package/dist/imageupload/utils.d.ts

@@ -1,35 +1,35 @@
 /**
- * @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/imageupload/utils
- */
-import type { ViewElement } from '@ckeditor/ckeditor5-engine';
-import { type ImageUtils } from '../imageutils.js';
+* @module image/imageupload/utils
+*/
+import type { ViewElement } from "@ckeditor/ckeditor5-engine";
+import { type ImageUtils } from "../imageutils.js";
 /**
- * Creates a regular expression used to test for image files.
- *
- * ```ts
- * const imageType = createImageTypeRegExp( [ 'png', 'jpeg', 'svg+xml', 'vnd.microsoft.icon' ] );
- *
- * console.log( 'is supported image', imageType.test( file.type ) );
- * ```
- */
+* Creates a regular expression used to test for image files.
+*
+* ```ts
+* const imageType = createImageTypeRegExp( [ 'png', 'jpeg', 'svg+xml', 'vnd.microsoft.icon' ] );
+*
+* console.log( 'is supported image', imageType.test( file.type ) );
+* ```
+*/
 export declare function createImageTypeRegExp(types: Array<string>): RegExp;
 /**
- * Creates a promise that fetches the image local source (Base64 or blob) and resolves with a `File` object.
- *
- * @internal
- * @param image Image whose source to fetch.
- * @returns A promise which resolves when an image source is fetched and converted to a `File` instance.
- * It resolves with a `File` object. If there were any errors during file processing, the promise will be rejected.
- */
+* Creates a promise that fetches the image local source (Base64 or blob) and resolves with a `File` object.
+*
+* @internal
+* @param image Image whose source to fetch.
+* @returns A promise which resolves when an image source is fetched and converted to a `File` instance.
+* It resolves with a `File` object. If there were any errors during file processing, the promise will be rejected.
+*/
 export declare function fetchLocalImage(image: ViewElement): Promise<File>;
 /**
- * Checks whether a given node is an image element with a local source (Base64 or blob).
- *
- * @param node The node to check.
- * @internal
- */
+* Checks whether a given node is an image element with a local source (Base64 or blob).
+*
+* @param node The node to check.
+* @internal
+*/
 export declare function isLocalImage(imageUtils: ImageUtils, node: ViewElement): boolean;