@ckeditor/ckeditor5-image 44.1.0 → 44.2.0-alpha.0

package/dist/imageupload/imageuploadui.d.ts

@@ -1,55 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageupload/imageuploadui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * 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 default 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;
-}

package/dist/imageupload/uploadimagecommand.d.ts

@@ -1,78 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
-/**
- * @module image/imageupload/uploadimagecommand
- */
-/**
- * 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 default 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;
-}

package/dist/imageupload/utils.d.ts

@@ -1,37 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageupload/utils
- */
-import type { ViewElement } from 'ckeditor5/src/engine.js';
-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 ) );
- * ```
- */
-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.
- *
- * @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.
- */
-export declare function isLocalImage(imageUtils: ImageUtils, node: ViewElement): boolean;

package/dist/imageupload.d.ts

@@ -1,40 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageupload
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageUploadUI from './imageupload/imageuploadui.js';
-import ImageUploadProgress from './imageupload/imageuploadprogress.js';
-import ImageUploadEditing from './imageupload/imageuploadediting.js';
-/**
- * The image upload plugin.
- *
- * For a detailed overview, check the {@glink features/images/image-upload/image-upload image upload feature} documentation.
- *
- * This plugin does not do anything directly, but it loads a set of specific plugins to enable image uploading:
- *
- * * {@link module:image/imageupload/imageuploadediting~ImageUploadEditing},
- * * {@link module:image/imageupload/imageuploadui~ImageUploadUI},
- * * {@link module:image/imageupload/imageuploadprogress~ImageUploadProgress}.
- */
-export default class ImageUpload extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageUpload";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUploadEditing, typeof ImageUploadUI, typeof ImageUploadProgress];
-}

package/dist/imageutils.d.ts

@@ -1,133 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/imageutils
- */
-import type { Element, ViewElement, DocumentSelection, ViewDocumentSelection, Selection, ViewSelection, DowncastWriter, Position, ViewContainerElement } from 'ckeditor5/src/engine.js';
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * A set of helpers related to images.
- */
-export default class ImageUtils extends Plugin {
-    /**
-     * DOM Emitter.
-     */
-    private _domEmitter;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageUtils";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * Checks if the provided model element is an `image` or `imageInline`.
-     */
-    isImage(modelElement?: Element | null): modelElement is Element & {
-        name: 'imageInline' | 'imageBlock';
-    };
-    /**
-     * Checks if the provided view element represents an inline image.
-     *
-     * Also, see {@link module:image/imageutils~ImageUtils#isImageWidget}.
-     */
-    isInlineImageView(element?: ViewElement | null): boolean;
-    /**
-     * Checks if the provided view element represents a block image.
-     *
-     * Also, see {@link module:image/imageutils~ImageUtils#isImageWidget}.
-     */
-    isBlockImageView(element?: ViewElement | null): boolean;
-    /**
-     * Handles inserting single file. This method unifies image insertion using {@link module:widget/utils~findOptimalInsertionRange}
-     * method.
-     *
-     * ```ts
-     * const imageUtils = editor.plugins.get( 'ImageUtils' );
-     *
-     * imageUtils.insertImage( { src: 'path/to/image.jpg' } );
-     * ```
-     *
-     * @param attributes Attributes of the inserted image.
-     * This method filters out the attributes which are disallowed by the {@link module:engine/model/schema~Schema}.
-     * @param selectable Place to insert the image. If not specified,
-     * the {@link module:widget/utils~findOptimalInsertionRange} logic will be applied for the block images
-     * and `model.document.selection` for the inline images.
-     *
-     * **Note**: If `selectable` is passed, this helper will not be able to set selection attributes (such as `linkHref`)
-     * and apply them to the new image. In this case, make sure all selection attributes are passed in `attributes`.
-     *
-     * @param imageType Image type of inserted image. If not specified,
-     * it will be determined automatically depending of editor config or place of the insertion.
-     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
-     * The default is `true`.
-     * @return The inserted model image element.
-     */
-    insertImage(attributes?: Record<string, unknown>, selectable?: Selection | Position | null, imageType?: ('imageBlock' | 'imageInline' | null), options?: {
-        setImageSizes?: boolean;
-    }): Element | null;
-    /**
-     * Reads original image sizes and sets them as `width` and `height`.
-     *
-     * The `src` attribute may not be available if the user is using an upload adapter. In such a case,
-     * this method is called again after the upload process is complete and the `src` attribute is available.
-     */
-    setImageNaturalSizeAttributes(imageElement: Element): void;
-    /**
-     * Returns an image widget editing view element if one is selected or is among the selection's ancestors.
-     */
-    getClosestSelectedImageWidget(selection: ViewSelection | ViewDocumentSelection): ViewElement | null;
-    /**
-     * Returns a image model element if one is selected or is among the selection's ancestors.
-     */
-    getClosestSelectedImageElement(selection: Selection | DocumentSelection): Element | null;
-    /**
-     * Returns an image widget editing view based on the passed image view.
-     */
-    getImageWidgetFromImageView(imageView: ViewElement): ViewContainerElement | null;
-    /**
-     * Checks if image can be inserted at current model selection.
-     *
-     * @internal
-     */
-    isImageAllowed(): boolean;
-    /**
-     * Converts a given {@link module:engine/view/element~Element} to an image widget:
-     * * Adds a {@link module:engine/view/element~Element#_setCustomProperty custom property} allowing to recognize the image widget
-     * element.
-     * * Calls the {@link module:widget/utils~toWidget} function with the proper element's label creator.
-     *
-     * @param writer An instance of the view writer.
-     * @param label The element's label. It will be concatenated with the image `alt` attribute if one is present.
-     */
-    toImageWidget(viewElement: ViewElement, writer: DowncastWriter, label: string): ViewElement;
-    /**
-     * Checks if a given view element is an image widget.
-     */
-    protected isImageWidget(viewElement: ViewElement): boolean;
-    /**
-     * Checks if the provided model element is an `image`.
-     */
-    isBlockImage(modelElement?: Element | null): boolean;
-    /**
-     * Checks if the provided model element is an `imageInline`.
-     */
-    isInlineImage(modelElement?: Element | null): boolean;
-    /**
-     * Get the view `<img>` from another view element, e.g. a widget (`<figure class="image">`), a link (`<a>`).
-     *
-     * The `<img>` can be located deep in other elements, so this helper performs a deep tree search.
-     */
-    findViewImgElement(figureView: ViewElement): ViewElement | undefined;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/index.d.ts

@@ -1,54 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image
- */
-export { default as AutoImage } from './autoimage.js';
-export { default as Image } from './image.js';
-export { default as ImageEditing } from './image/imageediting.js';
-export { default as ImageCaptionUtils } from './imagecaption/imagecaptionutils.js';
-export { default as ImageCaption } from './imagecaption.js';
-export { default as ImageCaptionEditing } from './imagecaption/imagecaptionediting.js';
-export { default as ImageInsert } from './imageinsert.js';
-export { default as ImageInsertUI } from './imageinsert/imageinsertui.js';
-export { default as ImageResize } from './imageresize.js';
-export { default as ImageResizeButtons } from './imageresize/imageresizebuttons.js';
-export { default as ImageResizeEditing } from './imageresize/imageresizeediting.js';
-export { default as ImageResizeHandles } from './imageresize/imageresizehandles.js';
-export { default as ImageCustomResizeUI } from './imageresize/imagecustomresizeui.js';
-export { default as ImageSizeAttributes } from './imagesizeattributes.js';
-export { default as ImageStyle } from './imagestyle.js';
-export { default as ImageStyleEditing } from './imagestyle/imagestyleediting.js';
-export { default as ImageStyleUI } from './imagestyle/imagestyleui.js';
-export { default as ImageTextAlternative } from './imagetextalternative.js';
-export { default as ImageTextAlternativeEditing } from './imagetextalternative/imagetextalternativeediting.js';
-export { default as ImageTextAlternativeUI } from './imagetextalternative/imagetextalternativeui.js';
-export { default as ImageToolbar } from './imagetoolbar.js';
-export { default as ImageUpload } from './imageupload.js';
-export { default as ImageUploadEditing, type ImageUploadCompleteEvent } from './imageupload/imageuploadediting.js';
-export { default as ImageUploadProgress } from './imageupload/imageuploadprogress.js';
-export { default as ImageUploadUI } from './imageupload/imageuploadui.js';
-export { default as PictureEditing } from './pictureediting.js';
-export { default as ImageBlock } from './imageblock.js';
-export { default as ImageInline } from './imageinline.js';
-export { default as ImageInsertViaUrl } from './imageinsertviaurl.js';
-export { default as ImageUtils } from './imageutils.js';
-export { default as ImageBlockEditing } from './image/imageblockediting.js';
-export { default as ImageCaptionUI } from './imagecaption/imagecaptionui.js';
-export { createImageTypeRegExp } from './imageupload/utils.js';
-export type { ImageConfig } from './imageconfig.js';
-export type { default as ImageTypeCommand } from './image/imagetypecommand.js';
-export type { default as InsertImageCommand } from './image/insertimagecommand.js';
-export type { default as ReplaceImageSourceCommand } from './image/replaceimagesourcecommand.js';
-export type { default as ToggleImageCaptionCommand } from './imagecaption/toggleimagecaptioncommand.js';
-export type { default as ResizeImageCommand } from './imageresize/resizeimagecommand.js';
-export type { default as ImageStyleCommand } from './imagestyle/imagestylecommand.js';
-export type { default as ImageTextAlternativeCommand } from './imagetextalternative/imagetextalternativecommand.js';
-export type { default as UploadImageCommand } from './imageupload/uploadimagecommand.js';
-import './augmentation.js';

package/dist/pictureediting.d.ts

@@ -1,96 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module image/pictureediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import ImageEditing from './image/imageediting.js';
-import ImageUtils from './imageutils.js';
-/**
- * This plugin enables the [`<picture>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture) element support in the editor.
- *
- * * It enables the `sources` model attribute on `imageBlock` and `imageInline` model elements
- * (brought by {@link module:image/imageblock~ImageBlock} and {@link module:image/imageinline~ImageInline}, respectively).
- * * It translates the `sources` model element to the view (also: data) structure that may look as follows:
- *
- * ```html
- * <p>Inline image using picture:
- * 	<picture>
- * 		<source media="(min-width: 800px)" srcset="image-large.webp" type="image/webp">
- * 		<source media="(max-width: 800px)" srcset="image-small.webp" type="image/webp">
- * 		<!-- Other sources as specified in the "sources" model attribute... -->
- * 		<img src="image.png" alt="An image using picture" />
- * 	</picture>
- * </p>
- *
- * <p>Block image using picture:</p>
- * <figure class="image">
- * 	<picture>
- * 		<source media="(min-width: 800px)" srcset="image-large.webp" type="image/webp">
- * 		<source media="(max-width: 800px)" srcset="image-small.webp" type="image/webp">
- * 		<!-- Other sources as specified in the "sources" model attribute... -->
- * 		<img src="image.png" alt="An image using picture" />
- * 	</picture>
- * 	<figcaption>Caption of the image</figcaption>
- * </figure>
- * ```
- *
- * **Note:** The value of the `sources` {@glink framework/architecture/editing-engine#changing-the-model model attribute}
- * in both examples equals:
- *
- * ```css
- * [
- * 	{
- * 		media: '(min-width: 800px)',
- * 		srcset: 'image-large.webp',
- * 		type: 'image/webp'
- * 	},
- * 	{
- * 		media: '(max-width: 800px)',
- * 		srcset: 'image-small.webp',
- * 		type: 'image/webp'
- * 	}
- * ]
- * ```
- *
- * * It integrates with the {@link module:image/imageupload~ImageUpload} plugin so images uploaded in the editor
- * automatically render using `<picture>` if the {@glink features/images/image-upload/image-upload upload adapter}
- * supports image sources and provides neccessary data.
- *
- * @private
- */
-export default class PictureEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageEditing, typeof ImageUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PictureEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Configures conversion pipelines to support upcasting and downcasting images using the `<picture>` view element
-     * and the model `sources` attribute.
-     */
-    private _setupConversion;
-    /**
-     * Makes it possible for uploaded images to get the `sources` model attribute and the `<picture>...</picture>`
-     * view structure out-of-the-box if relevant data is provided along the
-     * {@link module:image/imageupload/imageuploadediting~ImageUploadEditing#event:uploadComplete} event.
-     */
-    private _setupImageUploadEditingIntegration;
-}