@ckeditor/ckeditor5-media-embed 44.1.0 → 44.2.0-alpha.1

package/dist/mediaembedtoolbar.d.ts

@@ -1,38 +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 media-embed/mediaembedtoolbar
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { WidgetToolbarRepository } from 'ckeditor5/src/widget.js';
-import './mediaembedconfig.js';
-/**
- * The media embed toolbar plugin. It creates a toolbar for media embed that shows up when the media element is selected.
- *
- * Instances of toolbar components (e.g. buttons) are created based on the
- * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig#toolbar `media.toolbar` configuration option}.
- */
-export default class MediaEmbedToolbar extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof WidgetToolbarRepository];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "MediaEmbedToolbar";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/mediaembedui.d.ts

@@ -1,42 +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 media-embed/mediaembedui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { Dialog } from 'ckeditor5/src/ui.js';
-import MediaEmbedEditing from './mediaembedediting.js';
-/**
- * The media embed UI plugin.
- */
-export default class MediaEmbedUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof MediaEmbedEditing, typeof Dialog];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "MediaEmbedUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    private _formView;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a button for menu bar that will show media embed dialog.
-     */
-    private _createDialogButton;
-    private _showDialog;
-    private _handleSubmitForm;
-}

package/dist/mediaregistry.d.ts

@@ -1,70 +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 media-embed/mediaregistry
- */
-import type { DowncastWriter, ViewElement } from 'ckeditor5/src/engine.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-import type { MediaEmbedConfig, MediaEmbedProvider } from './mediaembedconfig.js';
-import type { MediaOptions } from './utils.js';
-/**
- * A bridge between the raw media content provider definitions and the editor view content.
- *
- * It helps translating media URLs to corresponding {@link module:engine/view/element~Element view elements}.
- *
- * Mostly used by the {@link module:media-embed/mediaembedediting~MediaEmbedEditing} plugin.
- */
-export default class MediaRegistry {
-    /**
-     * The {@link module:utils/locale~Locale} instance.
-     */
-    locale: Locale;
-    /**
-     * The media provider definitions available for the registry. Usually corresponding with the
-     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig media configuration}.
-     */
-    providerDefinitions: Array<MediaEmbedProvider>;
-    /**
-     * Creates an instance of the {@link module:media-embed/mediaregistry~MediaRegistry} class.
-     *
-     * @param locale The localization services instance.
-     * @param config The configuration of the media embed feature.
-     */
-    constructor(locale: Locale, config: MediaEmbedConfig);
-    /**
-     * Checks whether the passed URL is representing a certain media type allowed in the editor.
-     *
-     * @param url The URL to be checked
-     */
-    hasMedia(url: string): boolean;
-    /**
-     * For the given media URL string and options, it returns the {@link module:engine/view/element~Element view element}
-     * representing that media.
-     *
-     * **Note:** If no URL is specified, an empty view element is returned.
-     *
-     * @param writer The view writer used to produce a view element.
-     * @param url The URL to be translated into a view element.
-     */
-    getMediaViewElement(writer: DowncastWriter, url: string, options: MediaOptions): ViewElement;
-    /**
-     * Returns a `Media` instance for the given URL.
-     *
-     * @param url The URL of the media.
-     * @returns The `Media` instance or `null` when there is none.
-     */
-    private _getMedia;
-    /**
-     * Tries to match `url` to `pattern`.
-     *
-     * @param url The URL of the media.
-     * @param pattern The pattern that should accept the media URL.
-     */
-    private _getUrlMatches;
-}

package/dist/ui/mediaformview.d.ts

@@ -1,93 +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 media-embed/ui/mediaformview
- */
-import { type InputTextView, LabeledFieldView, View } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/mediaform.css';
-/**
- * The media form view controller class.
- *
- * See {@link module:media-embed/ui/mediaformview~MediaFormView}.
- */
-export default class MediaFormView extends View {
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The value of the URL input.
-     */
-    mediaURLInputValue: string;
-    /**
-     * The URL input view.
-     */
-    urlInputView: LabeledFieldView<InputTextView>;
-    /**
-     * An array of form validators used by {@link #isValid}.
-     */
-    private readonly _validators;
-    /**
-     * The default info text for the {@link #urlInputView}.
-     */
-    private _urlInputViewInfoDefault?;
-    /**
-     * The info text with an additional tip for the {@link #urlInputView},
-     * displayed when the input has some value.
-     */
-    private _urlInputViewInfoTip?;
-    /**
-     * @param validators Form validators used by {@link #isValid}.
-     * @param locale The localization services instance.
-     */
-    constructor(validators: Array<(v: MediaFormView) => string | undefined>, locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the {@link #urlInputView}.
-     */
-    focus(): void;
-    /**
-     * The native DOM `value` of the {@link #urlInputView} element.
-     *
-     * **Note**: Do not confuse it with the {@link module:ui/inputtext/inputtextview~InputTextView#value}
-     * which works one way only and may not represent the actual state of the component in the DOM.
-     */
-    get url(): string;
-    set url(url: string);
-    /**
-     * Validates the form and returns `false` when some fields are invalid.
-     */
-    isValid(): boolean;
-    /**
-     * Cleans up the supplementary error and information text of the {@link #urlInputView}
-     * bringing them back to the state when the form has been displayed for the first time.
-     *
-     * See {@link #isValid}.
-     */
-    resetFormStatus(): void;
-    /**
-     * Creates a labeled input view.
-     *
-     * @returns Labeled input view instance.
-     */
-    private _createUrlInput;
-}

package/dist/utils.d.ts

@@ -1,71 +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 media-embed/utils
- */
-import type { ViewContainerElement, Element, Model, Selectable, Selection, DowncastWriter, ViewDocumentSelection, ViewElement, DocumentSelection } from 'ckeditor5/src/engine.js';
-import type MediaRegistry from './mediaregistry.js';
-/**
- * Converts a given {@link module:engine/view/element~Element} to a media embed widget:
- * * Adds a {@link module:engine/view/element~Element#_setCustomProperty custom property} allowing to recognize the media 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.
- */
-export declare function toMediaWidget(viewElement: ViewElement, writer: DowncastWriter, label: string): ViewElement;
-/**
- * Returns a media widget editing view element if one is selected.
- */
-export declare function getSelectedMediaViewWidget(selection: ViewDocumentSelection): ViewElement | null;
-/**
- * Checks if a given view element is a media widget.
- */
-export declare function isMediaWidget(viewElement: ViewElement): boolean;
-/**
- * Creates a view element representing the media. Either a "semantic" one for the data pipeline:
- *
- * ```html
- * <figure class="media">
- * 	<oembed url="foo"></oembed>
- * </figure>
- * ```
- *
- * or a "non-semantic" (for the editing view pipeline):
- *
- * ```html
- * <figure class="media">
- * 	<div data-oembed-url="foo">[ non-semantic media preview for "foo" ]</div>
- * </figure>
- * ```
- */
-export declare function createMediaFigureElement(writer: DowncastWriter, registry: MediaRegistry, url: string, options: MediaOptions): ViewContainerElement;
-/**
- * Returns a selected media element in the model, if any.
- */
-export declare function getSelectedMediaModelWidget(selection: Selection | DocumentSelection): Element | null;
-/**
- * Creates a media element and inserts it into the model.
- *
- * **Note**: This method will use {@link module:engine/model/model~Model#insertContent `model.insertContent()`} logic of inserting content
- * if no `insertPosition` is passed.
- *
- * @param url An URL of an embeddable media.
- * @param findOptimalPosition If true it will try to find optimal position to insert media without breaking content
- * in which a selection is.
- */
-export declare function insertMedia(model: Model, url: string, selectable: Selectable, findOptimalPosition: boolean): void;
-/**
- * Type for commonly grouped function parameters across this package.
- */
-export type MediaOptions = {
-    elementName: string;
-    renderMediaPreview?: boolean;
-    renderForEditingView?: boolean;
-};