@ckeditor/ckeditor5-image 0.0.0-internal-20241017.0

package/src/image/imageplaceholder.js

@@ -0,0 +1,119 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/image/imageplaceholder
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageUtils from '../imageutils.js';
+import ImageLoadObserver from './imageloadobserver.js';
+import '../../theme/imageplaceholder.css';
+/**
+ * Adds support for image placeholder that is automatically removed when the image is loaded.
+ */
+export default class ImagePlaceholder extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageUtils];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImagePlaceholder';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        this._setupSchema();
+        this._setupConversion();
+        this._setupLoadListener();
+    }
+    /**
+     * Extends model schema.
+     */
+    _setupSchema() {
+        const schema = this.editor.model.schema;
+        // Wait for ImageBlockEditing or ImageInlineEditing to register their elements first,
+        // that's why doing this in afterInit() instead of init().
+        if (schema.isRegistered('imageBlock')) {
+            schema.extend('imageBlock', {
+                allowAttributes: ['placeholder']
+            });
+        }
+        if (schema.isRegistered('imageInline')) {
+            schema.extend('imageInline', {
+                allowAttributes: ['placeholder']
+            });
+        }
+    }
+    /**
+     * Registers converters.
+     */
+    _setupConversion() {
+        const editor = this.editor;
+        const conversion = editor.conversion;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        conversion.for('editingDowncast').add(dispatcher => {
+            dispatcher.on('attribute:placeholder', (evt, data, conversionApi) => {
+                if (!conversionApi.consumable.test(data.item, evt.name)) {
+                    return;
+                }
+                if (!data.item.is('element', 'imageBlock') && !data.item.is('element', 'imageInline')) {
+                    return;
+                }
+                conversionApi.consumable.consume(data.item, evt.name);
+                const viewWriter = conversionApi.writer;
+                const element = conversionApi.mapper.toViewElement(data.item);
+                const img = imageUtils.findViewImgElement(element);
+                if (data.attributeNewValue) {
+                    viewWriter.addClass('image_placeholder', img);
+                    viewWriter.setStyle('background-image', `url(${data.attributeNewValue})`, img);
+                    viewWriter.setCustomProperty('editingPipeline:doNotReuseOnce', true, img);
+                }
+                else {
+                    viewWriter.removeClass('image_placeholder', img);
+                    viewWriter.removeStyle('background-image', img);
+                }
+            });
+        });
+    }
+    /**
+     * Prepares listener for image load.
+     */
+    _setupLoadListener() {
+        const editor = this.editor;
+        const model = editor.model;
+        const editing = editor.editing;
+        const editingView = editing.view;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        editingView.addObserver(ImageLoadObserver);
+        this.listenTo(editingView.document, 'imageLoaded', (evt, domEvent) => {
+            const imgViewElement = editingView.domConverter.mapDomToView(domEvent.target);
+            if (!imgViewElement) {
+                return;
+            }
+            const viewElement = imageUtils.getImageWidgetFromImageView(imgViewElement);
+            if (!viewElement) {
+                return;
+            }
+            const modelElement = editing.mapper.toModelElement(viewElement);
+            if (!modelElement || !modelElement.hasAttribute('placeholder')) {
+                return;
+            }
+            model.enqueueChange({ isUndoable: false }, writer => {
+                writer.removeAttribute('placeholder', modelElement);
+            });
+        });
+    }
+}

package/src/image/imagetypecommand.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/image/imagetypecommand
+ */
+import type { Element } from 'ckeditor5/src/engine.js';
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The image type command. It changes the type of a selected image, depending on the configuration.
+ */
+export default class ImageTypeCommand extends Command {
+    /**
+     * Model element name the command converts to.
+     */
+    private readonly _modelElementName;
+    /**
+     * @inheritDoc
+     *
+     * @param modelElementName Model element name the command converts to.
+     */
+    constructor(editor: Editor, modelElementName: 'imageBlock' | 'imageInline');
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command and changes the type of a selected image.
+     *
+     * @fires execute
+     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
+     * The default is `true`.
+     * @returns An object containing references to old and new model image elements
+     * (for before and after the change) so external integrations can hook into the decorated
+     * `execute` event and handle this change. `null` if the type change failed.
+     */
+    execute(options?: {
+        setImageSizes?: boolean;
+    }): {
+        oldElement: Element;
+        newElement: Element;
+    } | null;
+}

package/src/image/imagetypecommand.js

@@ -0,0 +1,80 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The image type command. It changes the type of a selected image, depending on the configuration.
+ */
+export default class ImageTypeCommand extends Command {
+    /**
+     * @inheritDoc
+     *
+     * @param modelElementName Model element name the command converts to.
+     */
+    constructor(editor, modelElementName) {
+        super(editor);
+        this._modelElementName = modelElementName;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        const element = imageUtils.getClosestSelectedImageElement(this.editor.model.document.selection);
+        if (this._modelElementName === 'imageBlock') {
+            this.isEnabled = imageUtils.isInlineImage(element);
+        }
+        else {
+            this.isEnabled = imageUtils.isBlockImage(element);
+        }
+    }
+    /**
+     * Executes the command and changes the type of a selected image.
+     *
+     * @fires execute
+     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
+     * The default is `true`.
+     * @returns An object containing references to old and new model image elements
+     * (for before and after the change) so external integrations can hook into the decorated
+     * `execute` event and handle this change. `null` if the type change failed.
+     */
+    execute(options = {}) {
+        const editor = this.editor;
+        const model = this.editor.model;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        const oldElement = imageUtils.getClosestSelectedImageElement(model.document.selection);
+        const attributes = Object.fromEntries(oldElement.getAttributes());
+        // Don't change image type if "src" is missing (a broken image), unless there's "uploadId" set.
+        // This state may happen during image upload (before it finishes) and it should be possible to change type
+        // of the image in the meantime.
+        if (!attributes.src && !attributes.uploadId) {
+            return null;
+        }
+        return model.change(writer => {
+            const { setImageSizes = true } = options;
+            // Get all markers that contain the old image element.
+            const markers = Array.from(model.markers)
+                .filter(marker => marker.getRange().containsItem(oldElement));
+            const newElement = imageUtils.insertImage(attributes, model.createSelection(oldElement, 'on'), this._modelElementName, { setImageSizes });
+            if (!newElement) {
+                return null;
+            }
+            const newElementRange = writer.createRangeOn(newElement);
+            // Expand the previously intersecting markers' ranges to include the new image element.
+            for (const marker of markers) {
+                const markerRange = marker.getRange();
+                // Join the survived part of the old marker range with the new element range
+                // (loosely because there could be some new paragraph or the existing one might got split).
+                const range = markerRange.root.rootName != '$graveyard' ?
+                    markerRange.getJoined(newElementRange, true) : newElementRange;
+                writer.updateMarker(marker, { range });
+            }
+            return {
+                oldElement,
+                newElement
+            };
+        });
+    }
+}

package/src/image/insertimagecommand.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/image/insertimagecommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
+/**
+ * Insert image command.
+ *
+ * The command is registered by the {@link module:image/image/imageediting~ImageEditing} plugin as `insertImage`
+ * and it is also available via aliased `imageInsert` name.
+ *
+ * In order to insert an image at the current selection position
+ * (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
+ * execute the command and specify the image source:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', { source: 'http://url.to.the/image' } );
+ * ```
+ *
+ * It is also possible to insert multiple images at once:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', {
+ * 	source:  [
+ * 		'path/to/image.jpg',
+ * 		'path/to/other-image.jpg'
+ * 	]
+ * } );
+ * ```
+ *
+ * If you want to take the full control over the process, you can specify individual model attributes:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', {
+ * 	source:  [
+ * 		{ src: 'path/to/image.jpg', alt: 'First alt text' },
+ * 		{ src: 'path/to/other-image.jpg', alt: 'Second alt text', customAttribute: 'My attribute value' }
+ * 	]
+ * } );
+ * ```
+ */
+export default class InsertImageCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Options for the executed command.
+     * @param options.imageType The type of the image to insert. If not specified, the type will be determined automatically.
+     * @param options.source The image source or an array of image sources to insert.
+     * See the documentation of the command to learn more about accepted formats.
+     */
+    execute(options: {
+        source: ArrayOrItem<string | Record<string, unknown>>;
+        imageType?: 'imageBlock' | 'imageInline' | null;
+    }): void;
+}

package/src/image/insertimagecommand.js

@@ -0,0 +1,121 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/image/insertimagecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { logWarning, toArray } from 'ckeditor5/src/utils.js';
+/**
+ * Insert image command.
+ *
+ * The command is registered by the {@link module:image/image/imageediting~ImageEditing} plugin as `insertImage`
+ * and it is also available via aliased `imageInsert` name.
+ *
+ * In order to insert an image at the current selection position
+ * (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
+ * execute the command and specify the image source:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', { source: 'http://url.to.the/image' } );
+ * ```
+ *
+ * It is also possible to insert multiple images at once:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', {
+ * 	source:  [
+ * 		'path/to/image.jpg',
+ * 		'path/to/other-image.jpg'
+ * 	]
+ * } );
+ * ```
+ *
+ * If you want to take the full control over the process, you can specify individual model attributes:
+ *
+ * ```ts
+ * editor.execute( 'insertImage', {
+ * 	source:  [
+ * 		{ src: 'path/to/image.jpg', alt: 'First alt text' },
+ * 		{ src: 'path/to/other-image.jpg', alt: 'Second alt text', customAttribute: 'My attribute value' }
+ * 	]
+ * } );
+ * ```
+ */
+export default class InsertImageCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        const configImageInsertType = editor.config.get('image.insert.type');
+        if (!editor.plugins.has('ImageBlockEditing')) {
+            if (configImageInsertType === 'block') {
+                /**
+                 * The {@link module:image/imageblock~ImageBlock} plugin must be enabled to allow inserting block images. See
+                 * {@link module:image/imageconfig~ImageInsertConfig#type} to learn more.
+                 *
+                 * @error image-block-plugin-required
+                 */
+                logWarning('image-block-plugin-required');
+            }
+        }
+        if (!editor.plugins.has('ImageInlineEditing')) {
+            if (configImageInsertType === 'inline') {
+                /**
+                 * The {@link module:image/imageinline~ImageInline} plugin must be enabled to allow inserting inline images. See
+                 * {@link module:image/imageconfig~ImageInsertConfig#type} to learn more.
+                 *
+                 * @error image-inline-plugin-required
+                 */
+                logWarning('image-inline-plugin-required');
+            }
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const imageUtils = this.editor.plugins.get('ImageUtils');
+        this.isEnabled = imageUtils.isImageAllowed();
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Options for the executed command.
+     * @param options.imageType The type of the image to insert. If not specified, the type will be determined automatically.
+     * @param options.source The image source or an array of image sources to insert.
+     * See the documentation of the command to learn more about accepted formats.
+     */
+    execute(options) {
+        const sourceDefinitions = toArray(options.source);
+        const selection = this.editor.model.document.selection;
+        const imageUtils = this.editor.plugins.get('ImageUtils');
+        // In case of multiple images, each image (starting from the 2nd) will be inserted at a position that
+        // follows the previous one. That will move the selection and, to stay on the safe side and make sure
+        // all images inherit the same selection attributes, they are collected beforehand.
+        //
+        // Applying these attributes ensures, for instance, that inserting an (inline) image into a link does
+        // not split that link but preserves its continuity.
+        //
+        // Note: Selection attributes that do not make sense for images will be filtered out by insertImage() anyway.
+        const selectionAttributes = Object.fromEntries(selection.getAttributes());
+        sourceDefinitions.forEach((sourceDefinition, index) => {
+            const selectedElement = selection.getSelectedElement();
+            if (typeof sourceDefinition === 'string') {
+                sourceDefinition = { src: sourceDefinition };
+            }
+            // Inserting of an inline image replace the selected element and make a selection on the inserted image.
+            // Therefore inserting multiple inline images requires creating position after each element.
+            if (index && selectedElement && imageUtils.isImage(selectedElement)) {
+                const position = this.editor.model.createPositionAfter(selectedElement);
+                imageUtils.insertImage({ ...sourceDefinition, ...selectionAttributes }, position, options.imageType);
+            }
+            else {
+                imageUtils.insertImage({ ...sourceDefinition, ...selectionAttributes }, null, options.imageType);
+            }
+        });
+    }
+}

package/src/image/replaceimagesourcecommand.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { Writer, Element } from 'ckeditor5/src/engine.js';
+/**
+ * @module image/image/replaceimagesourcecommand
+ */
+/**
+ * Replace image source command.
+ *
+ * Changes image source to the one provided. Can be executed as follows:
+ *
+ * ```ts
+ * editor.execute( 'replaceImageSource', { source: 'http://url.to.the/image' } );
+ * ```
+ */
+export default class ReplaceImageSourceCommand extends Command {
+    value: string | null;
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Options for the executed command.
+     * @param options.source The image source to replace.
+     */
+    execute(options: {
+        source: string;
+    }): void;
+    /**
+     * Cleanup image attributes that are not relevant to the new source.
+     *
+     * Removed attributes are: 'srcset', 'sizes', 'sources', 'width', 'height', 'alt'.
+     *
+     * This method is decorated, to allow custom cleanup logic.
+     * For example, to remove 'myImageId' attribute after 'src' has changed:
+     *
+     * ```ts
+     * replaceImageSourceCommand.on( 'cleanupImage', ( eventInfo, [ writer, image ] ) => {
+     * 	writer.removeAttribute( 'myImageId', image );
+     * } );
+     * ```
+     */
+    cleanupImage(writer: Writer, image: Element): void;
+}

package/src/image/replaceimagesourcecommand.js

@@ -0,0 +1,75 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * @module image/image/replaceimagesourcecommand
+ */
+/**
+ * Replace image source command.
+ *
+ * Changes image source to the one provided. Can be executed as follows:
+ *
+ * ```ts
+ * editor.execute( 'replaceImageSource', { source: 'http://url.to.the/image' } );
+ * ```
+ */
+export default class ReplaceImageSourceCommand extends Command {
+    constructor(editor) {
+        super(editor);
+        this.decorate('cleanupImage');
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        const element = this.editor.model.document.selection.getSelectedElement();
+        this.isEnabled = imageUtils.isImage(element);
+        this.value = this.isEnabled ? element.getAttribute('src') : null;
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options Options for the executed command.
+     * @param options.source The image source to replace.
+     */
+    execute(options) {
+        const image = this.editor.model.document.selection.getSelectedElement();
+        const imageUtils = this.editor.plugins.get('ImageUtils');
+        this.editor.model.change(writer => {
+            writer.setAttribute('src', options.source, image);
+            this.cleanupImage(writer, image);
+            imageUtils.setImageNaturalSizeAttributes(image);
+        });
+    }
+    /**
+     * Cleanup image attributes that are not relevant to the new source.
+     *
+     * Removed attributes are: 'srcset', 'sizes', 'sources', 'width', 'height', 'alt'.
+     *
+     * This method is decorated, to allow custom cleanup logic.
+     * For example, to remove 'myImageId' attribute after 'src' has changed:
+     *
+     * ```ts
+     * replaceImageSourceCommand.on( 'cleanupImage', ( eventInfo, [ writer, image ] ) => {
+     * 	writer.removeAttribute( 'myImageId', image );
+     * } );
+     * ```
+     */
+    cleanupImage(writer, image) {
+        writer.removeAttribute('srcset', image);
+        writer.removeAttribute('sizes', image);
+        /**
+         * In case responsive images some attributes should be cleaned up.
+         * Check: https://github.com/ckeditor/ckeditor5/issues/15093
+         */
+        writer.removeAttribute('sources', image);
+        writer.removeAttribute('width', image);
+        writer.removeAttribute('height', image);
+        writer.removeAttribute('alt', image);
+    }
+}

package/src/image/ui/utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module image/image/ui/utils
+ */
+import type { PositionOptions } from 'ckeditor5/src/utils.js';
+import type { Editor } from 'ckeditor5/src/core.js';
+/**
+ * A helper utility that positions the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
+ * with respect to the image in the editor content, if one is selected.
+ *
+ * @param editor The editor instance.
+ */
+export declare function repositionContextualBalloon(editor: Editor): void;
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected element in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export declare function getBalloonPositionData(editor: Editor): Partial<PositionOptions>;

package/src/image/ui/utils.js

@@ -0,0 +1,44 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { BalloonPanelView } from 'ckeditor5/src/ui.js';
+/**
+ * A helper utility that positions the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} instance
+ * with respect to the image in the editor content, if one is selected.
+ *
+ * @param editor The editor instance.
+ */
+export function repositionContextualBalloon(editor) {
+    const balloon = editor.plugins.get('ContextualBalloon');
+    const imageUtils = editor.plugins.get('ImageUtils');
+    if (imageUtils.getClosestSelectedImageWidget(editor.editing.view.document.selection)) {
+        const position = getBalloonPositionData(editor);
+        balloon.updatePosition(position);
+    }
+}
+/**
+ * Returns the positioning options that control the geometry of the
+ * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon} with respect
+ * to the selected element in the editor content.
+ *
+ * @param editor The editor instance.
+ */
+export function getBalloonPositionData(editor) {
+    const editingView = editor.editing.view;
+    const defaultPositions = BalloonPanelView.defaultPositions;
+    const imageUtils = editor.plugins.get('ImageUtils');
+    return {
+        target: editingView.domConverter.mapViewToDom(imageUtils.getClosestSelectedImageWidget(editingView.document.selection)),
+        positions: [
+            defaultPositions.northArrowSouth,
+            defaultPositions.northArrowSouthWest,
+            defaultPositions.northArrowSouthEast,
+            defaultPositions.southArrowNorth,
+            defaultPositions.southArrowNorthWest,
+            defaultPositions.southArrowNorthEast,
+            defaultPositions.viewportStickyNorth
+        ]
+    };
+}