@ckeditor/ckeditor5-ckbox 41.3.0-alpha.4 → 41.3.0

package/dist/types/ckboxediting.d.ts

@@ -1,58 +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-oss-license
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import CKBoxUploadAdapter from './ckboxuploadadapter.js';
-import CKBoxUtils from './ckboxutils.js';
-/**
- * The CKBox editing feature. It introduces the {@link module:ckbox/ckboxcommand~CKBoxCommand CKBox command} and
- * {@link module:ckbox/ckboxuploadadapter~CKBoxUploadAdapter CKBox upload adapter}.
- */
-export default class CKBoxEditing extends Plugin {
-    /**
-     * CKEditor Cloud Services access token.
-     */
-    private _token;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["LinkEditing", "PictureEditing", typeof CKBoxUploadAdapter, typeof CKBoxUtils];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Returns true only when the integrator intentionally wants to use the plugin, i.e. when the `config.ckbox` exists or
-     * the CKBox JavaScript library is loaded.
-     */
-    private _shouldBeInitialised;
-    /**
-     * Checks if at least one image plugin is loaded.
-     */
-    private _checkImagePlugins;
-    /**
-     * Extends the schema to allow the `ckboxImageId` and `ckboxLinkId` attributes for links and images.
-     */
-    private _initSchema;
-    /**
-     * Configures the upcast and downcast conversions for the `ckboxImageId` and `ckboxLinkId` attributes.
-     */
-    private _initConversion;
-    /**
-     * Registers post-fixers that add or remove the `ckboxLinkId` and `ckboxImageId` attributes.
-     */
-    private _initFixers;
-}

package/dist/types/ckboximageedit/ckboximageeditcommand.d.ts

@@ -1,101 +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-oss-license
- */
-/**
- * @module ckbox/ckboximageedit/ckboximageeditcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The CKBox edit image command.
- *
- * Opens the CKBox dialog for editing the image.
- */
-export default class CKBoxImageEditCommand extends Command {
-    /**
-     * Flag indicating whether the command is active, i.e. dialog is open.
-     */
-    value: boolean;
-    /**
-     * The DOM element that acts as a mounting point for the CKBox Edit Image dialog.
-     */
-    private _wrapper;
-    /**
-     * The states of image processing in progress.
-     */
-    private _processInProgress;
-    /**
-     * Determines if the element can be edited.
-     */
-    private _canEdit;
-    /**
-     * A wrapper function to prepare mount options. Ensures that at most one preparation is in-flight.
-     */
-    private _prepareOptions;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Opens the CKBox Image Editor dialog for editing the image.
-     */
-    execute(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Indicates if the CKBox Image Editor dialog is already opened.
-     */
-    private _getValue;
-    /**
-     * Creates the options object for the CKBox Image Editor dialog.
-     */
-    private _prepareOptionsAbortable;
-    /**
-     * Initializes event lister for an event of removing an image.
-     */
-    private _prepareListeners;
-    /**
-     * Gets processing states of images that have been deleted in the mean time.
-     */
-    private _getProcessingStatesOfDeletedImages;
-    private _checkIfElementIsBeingProcessed;
-    /**
-     * Closes the CKBox Image Editor dialog.
-     */
-    private _handleImageEditorClose;
-    /**
-     * Save edited image. In case server respond with "success" replace with edited image,
-     * otherwise show notification error.
-     */
-    private _handleImageEditorSave;
-    /**
-     * Get asset's status on server. If server responds with "success" status then
-     * image is already proceeded and ready for saving.
-     */
-    private _getAssetStatusFromServer;
-    /**
-     * Waits for an asset to be processed.
-     * It retries retrieving asset status from the server in case of failure.
-     */
-    private _waitForAssetProcessed;
-    /**
-     * Shows processing indicator while image is processing.
-     *
-     * @param asset Data about certain asset.
-     */
-    private _showImageProcessingIndicator;
-    /**
-     * Replace the edited image with the new one.
-     */
-    private _replaceImage;
-}

package/dist/types/ckboximageedit/ckboximageeditediting.d.ts

@@ -1,32 +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-oss-license
- */
-/**
- * @module ckbox/ckboximageedit/ckboximageeditediting
- */
-import { PendingActions, Plugin } from 'ckeditor5/src/core.js';
-import { Notification } from 'ckeditor5/src/ui.js';
-import CKBoxEditing from '../ckboxediting.js';
-import CKBoxUtils from '../ckboxutils.js';
-/**
- * The CKBox image edit editing plugin.
- */
-export default class CKBoxImageEditEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxImageEditEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CKBoxEditing, typeof CKBoxUtils, typeof PendingActions, typeof Notification, "ImageUtils", "ImageEditing"];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/ckboximageedit/ckboximageeditui.d.ts

@@ -1,28 +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-oss-license
- */
-/**
- * @module ckbox/ckboximageedit/ckboximageeditui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The UI plugin of the CKBox image edit feature.
- *
- * It registers the `'ckboxImageEdit'` UI button in the editor's {@link module:ui/componentfactory~ComponentFactory component factory}
- * that allows you to open the CKBox dialog and edit the image.
- */
-export default class CKBoxImageEditUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxImageEditUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/ckboximageedit/utils.d.ts

@@ -1,14 +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-oss-license
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import type { CKBoxConfig } from '../ckboxconfig.js';
-/**
- * @internal
- */
-export declare function createEditabilityChecker(allowExternalImagesEditing: CKBoxConfig['allowExternalImagesEditing']): (element: Element) => boolean;

package/dist/types/ckboximageedit.d.ts

@@ -1,28 +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-oss-license
- */
-/**
- * @module ckbox/ckboximageedit
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import CKBoxImageEditEditing from './ckboximageedit/ckboximageeditediting.js';
-import CKBoxImageEditUI from './ckboximageedit/ckboximageeditui.js';
-import '../theme/ckboximageedit.css';
-/**
- * The CKBox image edit feature.
- */
-export default class CKBoxImageEdit extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxImageEdit";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CKBoxImageEditEditing, typeof CKBoxImageEditUI];
-}

package/dist/types/ckboxui.d.ts

@@ -1,25 +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-oss-license
- */
-/**
- * @module ckbox/ckboxui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The CKBoxUI plugin. It introduces the `'ckbox'` toolbar button.
- */
-export default class CKBoxUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxUI";
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/types/ckboxuploadadapter.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-oss-license
- */
-/**
- * @module ckbox/ckboxuploadadapter
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { FileRepository } from 'ckeditor5/src/upload.js';
-import CKBoxEditing from './ckboxediting.js';
-/**
- * A plugin that enables file uploads in CKEditor 5 using the CKBox server–side connector.
- * See the {@glink features/file-management/ckbox CKBox file manager integration} guide to learn how to configure
- * and use this feature as well as find out more about the full integration with the file manager
- * provided by the {@link module:ckbox/ckbox~CKBox} plugin.
- *
- * Check out the {@glink features/images/image-upload/image-upload Image upload overview} guide to learn about
- * other ways to upload images into CKEditor 5.
- */
-export default class CKBoxUploadAdapter extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["ImageUploadEditing", "ImageUploadProgress", typeof FileRepository, typeof CKBoxEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxUploadAdapter";
-    /**
-     * @inheritDoc
-     */
-    afterInit(): Promise<void>;
-}

package/dist/types/ckboxutils.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-oss-license
- */
-/**
- * @module ckbox/ckboxutils
- */
-import type { InitializedToken } from '@ckeditor/ckeditor5-cloud-services';
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The CKBox utilities plugin.
- */
-export default class CKBoxUtils extends Plugin {
-    /**
-     * CKEditor Cloud Services access token.
-     */
-    private _token;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxUtils";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["CloudServices"];
-    /**
-     * @inheritDoc
-     */
-    init(): Promise<void>;
-    /**
-     * Returns a token used by the CKBox plugin for communication with the CKBox service.
-     */
-    getToken(): InitializedToken;
-    /**
-     * The ID of workspace to use when uploading an image.
-     */
-    getWorkspaceId(): string;
-    /**
-     * Resolves a promise with an object containing a category with which the uploaded file is associated or an error code.
-     */
-    getCategoryIdForFile(fileOrUrl: File | string, options: {
-        signal: AbortSignal;
-    }): Promise<string>;
-    /**
-     * Resolves a promise with an array containing available categories with which the uploaded file can be associated.
-     *
-     * If the API returns limited results, the method will collect all items.
-     */
-    private _getAvailableCategories;
-}

package/dist/types/index.d.ts

@@ -1,21 +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-oss-license
- */
-/**
- * @module ckbox
- */
-export { default as CKBox } from './ckbox.js';
-export { default as CKBoxEditing } from './ckboxediting.js';
-export { default as CKBoxUI } from './ckboxui.js';
-export { default as CKBoxImageEditEditing } from './ckboximageedit/ckboximageeditediting.js';
-export { default as CKBoxImageEditUI } from './ckboximageedit/ckboximageeditui.js';
-export { default as CKBoxImageEdit } from './ckboximageedit.js';
-export type { default as CKBoxCommand } from './ckboxcommand.js';
-export type { default as CKBoxImageEditCommand } from './ckboximageedit/ckboximageeditcommand.js';
-export type { CKBoxConfig } from './ckboxconfig.js';
-import './augmentation.js';

package/dist/types/utils.d.ts

@@ -1,67 +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-oss-license
- */
-/**
- * @module ckbox/utils
- */
-import type { InitializedToken } from '@ckeditor/ckeditor5-cloud-services';
-import type { CKBoxImageUrls } from './ckboxconfig.js';
-/**
- * Converts image source set provided by the CKBox into an object containing:
- * - responsive URLs for the "webp" image format,
- * - one fallback URL for browsers that do not support the "webp" format.
- */
-export declare function getImageUrls(imageUrls: CKBoxImageUrls): {
-    imageFallbackUrl: string;
-    imageSources: Array<{
-        srcset: string;
-        sizes: string;
-        type: string;
-    }>;
-};
-/**
- * Returns a workspace id to use for communication with the CKBox service.
- *
- * @param defaultWorkspaceId The default workspace to use taken from editor config.
- */
-export declare function getWorkspaceId(token: InitializedToken, defaultWorkspaceId?: string): string | null;
-/**
- * Generates an image data URL from its `blurhash` representation.
- */
-export declare function blurHashToDataUrl(hash?: string): string | undefined;
-/**
- * Sends the HTTP request.
- *
- * @internal
- * @param config.url the URL where the request will be sent.
- * @param config.method The HTTP method.
- * @param config.data Additional data to send.
- * @param config.onUploadProgress A callback informing about the upload progress.
- */
-export declare function sendHttpRequest({ url, method, data, onUploadProgress, signal, authorization }: {
-    url: URL;
-    signal: AbortSignal;
-    authorization: string;
-    method?: 'GET' | 'POST';
-    data?: FormData | null;
-    onUploadProgress?: (evt: ProgressEvent) => void;
-}): Promise<any>;
-/**
- * Returns an extension a typical file in the specified `mimeType` format would have.
- */
-export declare function convertMimeTypeToExtension(mimeType: string): string;
-/**
- * Tries to fetch the given `url` and returns 'content-type' of the response.
- */
-export declare function getContentTypeOfUrl(url: string, options: {
-    signal: AbortSignal;
-}): Promise<string>;
-/**
- * Returns an extension from the given value.
- */
-export declare function getFileExtension(file: File): string;