@ckeditor/ckeditor5-ckbox 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/ckboxconfig.d.ts

@@ -1,434 +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 ckbox/ckboxconfig
- */
-import type { TokenUrl } from '@ckeditor/ckeditor5-cloud-services';
-import type { ArrayOrItem } from 'ckeditor5/src/utils.js';
-/**
- * The configuration of the {@link module:ckbox/ckbox~CKBox CKBox feature}.
- *
- * The minimal configuration for the CKBox feature requires providing the
- * {@link module:ckbox/ckboxconfig~CKBoxConfig#tokenUrl `config.ckbox.tokenUrl`}:
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		ckbox: {
- * 			tokenUrl: 'https://example.com/cs-token-endpoint'
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * Hovewer, you can also adjust the feature to fit your needs:
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		ckbox: {
- * 			defaultUploadCategories: {
- * 				Bitmaps: [ 'bmp' ],
- * 				Pictures: [ 'jpg', 'jpeg' ],
- * 				Scans: [ 'png', 'tiff' ]
- * 			},
- * 			ignoreDataId: true,
- * 			serviceOrigin: 'https://example.com/',
- * 			tokenUrl: 'https://example.com/cs-token-endpoint'
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface CKBoxConfig {
-    /**
-     * The authentication token URL for CKBox feature.
-     *
-     * Defaults to {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl `config.cloudServices.tokenUrl`}
-     */
-    tokenUrl?: TokenUrl;
-    /**
-     * The theme for CKBox dialog.
-     */
-    theme?: string;
-    /**
-     * Defines the categories to which the uploaded images will be assigned.
-     * If configured, it overrides the category mappings defined on the cloud service.
-     * The value of this option should be an object, where the keys define categories and their values are the types of images
-     * that will be uploaded to these categories. The categories might be referenced by their name or ID.
-     *
-     * Example:
-     *
-     * ```ts
-     * const ckboxConfig = {
-     * 	defaultUploadCategories: {
-     * 		Bitmaps: [ 'bmp' ],
-     * 		Pictures: [ 'jpg', 'jpeg' ],
-     * 		Scans: [ 'png', 'tiff' ],
-     * 		// The category below is referenced by its ID.
-     * 		'fdf2a647-b67f-4a6c-b692-5ba1dc1ed87b': [ 'gif' ]
-     * 	}
-     * };
-     * ```
-     *
-     * @default null
-     */
-    defaultUploadCategories?: Record<string, Array<string>> | null;
-    /**
-     * Defines the workspace id to use during upload when the user has access to more than one workspace.
-     *
-     * If defined, it is an error, when the user has no access to the specified workspace.
-     */
-    defaultUploadWorkspaceId?: string;
-    /**
-     * Enforces displaying the "Powered by CKBox" link regardless of the CKBox plan used.
-     */
-    forceDemoLabel?: boolean;
-    /**
-     * Allows editing images that are not hosted in CKBox service.
-     *
-     * This configuration option should whitelist URL(s) of images that should be editable.
-     * Make sure that allowed image resources have CORS enabled.
-     *
-     * The image is editable if this option is:
-     * * a regular expression and it matches the image URL, or
-     * * a custom function that returns `true` for the image URL, or
-     * * `'origin'` literal and the image URL is from the same origin, or
-     * * an array of the above and the image URL matches one of the array elements.
-     *
-     * Images hosted in CKBox are always editable.
-     *
-     * @default []
-     */
-    allowExternalImagesEditing?: ArrayOrItem<RegExp | 'origin' | ((src: string) => boolean)>;
-    /**
-     * Inserts the unique asset ID as the `data-ckbox-resource-id` attribute. To disable this behavior, set it to `true`.
-     *
-     * @default false
-     */
-    ignoreDataId?: boolean;
-    /**
-     * Configures the base URL of the API service. Required only in on-premises installations.
-     *
-     * @default 'https://api.ckbox.io'
-     */
-    serviceOrigin?: string;
-    /**
-     * Configures the language for the CKBox dialog.
-     *
-     * Defaults to {@link module:utils/locale~Locale#uiLanguage `Locale#uiLanguage`}
-     */
-    language?: string;
-    /**
-     * This option allows opening CKBox in dialog mode. It takes a configuration object with
-     * the width and height attributes.
-     */
-    dialog?: CKBoxDialogConfig;
-    /**
-     * Allows setting custom icons for categories.
-     */
-    categories?: CKBoxCategoriesConfig;
-    /**
-     * Configures the view of CKBox.
-     */
-    view?: CKBoxViewConfig;
-    /**
-     * Configures when dialog should be minimized and hidden.
-     */
-    upload?: CKBoxUploadConfig;
-    /**
-     * Specifies the file extensions considered valid for user interaction. Whith this
-     * option developers can restrict user interaction to only those assets whose file
-     * extensions match those listed in the array. Assets whose file
-     * extensions are not listed in the `choosableFileExtensions` array are
-     * automatically disabled within the CKBox interface.
-     *
-     * ```ts
-     * const ckboxConfig = {
-     *		choosableFileExtensions: ['jpg', 'png']
-     * };
-     * ```
-     */
-    choosableFileExtensions?: Array<string>;
-}
-export interface CKBoxDialogConfig {
-    /**
-     * The dialog width in pixels.
-     */
-    width: number;
-    /**
-     * The dialog height in pixels.
-     */
-    height: number;
-}
-export interface CKBoxCategoriesConfig {
-    /**
-     * This option takes an object with categories and icons that should be used instead
-     * of the default ones. Categories can be defined using either their name or id.
-     * Icons should be defined as strings containing the SVG images, or as React components.
-     *
-     * ```ts
-     * const ckboxConfig = {
-     * 		categories: {
-     * 				icons: {
-     * 					Images: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"><path ... /></svg>',
-     * 					// Category can be referenced by ID
-     * 					// 'fdf2a647-b67f-4a6c-b692-5ba1dc1ed87b': '<svg...'
-     * 				}
-     * 		}
-     * }
-     * ```
-     */
-    icons?: {
-        [key: string]: string;
-    };
-}
-export interface CKBoxViewConfig {
-    /**
-     * If it is set to `false` the last view visited by the user will not be reopened on
-     * the next startup.
-     */
-    openLastView?: boolean;
-    /**
-     * Sets the ID of the folder that will be opened on startup. This option can be paired
-     * with setting `view.openLastView` to `false` to enforce CKBox to always open in a given
-     * folder at startup.
-     */
-    startupFolderId?: string;
-    /**
-     * Sets the ID of the category that will be opened on startup. This option can be paired
-     * with setting `view.openLastView` to `false` to enforce CKBox to always open in a given
-     * category at startup. If `view.startupCategoryId` is passed along with the
-     * `view.startupFolderId` option, CKBox will prioritize opening category view on the startup.
-     */
-    startupCategoryId?: string;
-    /**
-     * Sets whether to hide the ‘Maximize’ button. By default, the button is shown and enabling
-     * this option will hide it.
-     */
-    hideMaximizeButton?: boolean;
-}
-export interface CKBoxUploadConfig {
-    /**
-     * Sets timeout (in milliseconds) after which upload components (dialog and indicator) are
-     * hidden. By default, these components hide automatically after 10 seconds.
-     *
-     * Read more: https://ckeditor.com/docs/ckbox/latest/guides/configuration/configuration-options.html#uploadcomponentshidetimeout
-     */
-    componentsHideTimeout?: number;
-    /**
-     * Sets timeout (in milliseconds) after which upload dialog is minimized once upload is
-     * finished and all uploads were successful. By default, upload dialog is never minimized
-     * automatically.
-     *
-     * Read more: https://ckeditor.com/docs/ckbox/latest/guides/configuration/configuration-options.html#uploaddialogminimizetimeout
-     */
-    dialogMinimizeTimeout?: number;
-}
-/**
- * Asset definition.
- *
- * The definition contains the unique `id`, asset `type` and an `attributes` definition.
- */
-export type CKBoxAssetDefinition = CKBoxAssetImageDefinition | CKBoxAssetLinkDefinition;
-/**
- * Image asset definition.
- *
- * The definition contains the unique `id`, asset `type` and an `attributes` definition.
- */
-export interface CKBoxAssetImageDefinition {
-    /**
-     * An unique asset id.
-     */
-    id: string;
-    /**
-     * Asset type.
-     */
-    type: 'image';
-    /**
-     * Asset attributes.
-     */
-    attributes: CKBoxAssetImageAttributesDefinition;
-}
-/**
- * Link asset definition.
- *
- * The definition contains the unique `id`, asset `type` and an `attributes` definition.
- */
-export interface CKBoxAssetLinkDefinition {
-    /**
-     * An unique asset id.
-     */
-    id: string;
-    /**
-     * Asset type.
-     */
-    type: 'link';
-    /**
-     * Asset attributes.
-     */
-    attributes: CKBoxAssetLinkAttributesDefinition;
-}
-/**
- * Asset attributes definition for an image.
- *
- * The definition contains the `imageFallbackUrl`, an `imageSources` array with one image source definition object and the
- * `imageTextAlternative`.
- *
- * ```ts
- * {
- * 	imageFallbackUrl: 'https://example.com/assets/asset-id/images/1000.png',
- * 	imageSources: [
- * 		{
- * 			sizes: '1000px',
- * 			srcset:
- * 				'https://example.com/assets/asset-id/images/100.webp 100w,' +
- * 				'https://example.com/assets/asset-id/images/200.webp 200w,' +
- * 				'https://example.com/assets/asset-id/images/300.webp 300w,' +
- * 				'https://example.com/assets/asset-id/images/400.webp 400w,' +
- * 				'https://example.com/assets/asset-id/images/500.webp 500w,' +
- * 				'https://example.com/assets/asset-id/images/600.webp 600w,' +
- * 				'https://example.com/assets/asset-id/images/700.webp 700w,' +
- * 				'https://example.com/assets/asset-id/images/800.webp 800w,' +
- * 				'https://example.com/assets/asset-id/images/900.webp 900w,' +
- * 				'https://example.com/assets/asset-id/images/1000.webp 1000w',
- * 			type: 'image/webp'
- * 		}
- * 	],
- * 	imageTextAlternative: 'An alternative text for the image'
- * }
- * ```
- */
-export interface CKBoxAssetImageAttributesDefinition {
-    /**
-     * A fallback URL for browsers that do not support the "webp" format.
-     */
-    imageFallbackUrl: string;
-    /**
-     * An array containing one image source definition object.
-     */
-    imageSources: Array<{
-        srcset: string;
-        sizes: string;
-        type: string;
-    }>;
-    /**
-     * An alternative text for an image.
-     */
-    imageTextAlternative: string;
-    /**
-     * Image width.
-     */
-    imageWidth?: number;
-    /**
-     * Image height.
-     */
-    imageHeight?: number;
-    /**
-     * Image placeholder image.
-     */
-    imagePlaceholder?: string;
-}
-/**
- * Asset attributes definition for a link.
- *
- * The definition contains the `linkName` and `linkHref` strings.
- *
- * ```ts
- * {
- * 	linkName: 'File name',
- * 	linkHref: 'https://example.com/assets/asset-id/file.pdf'
- * }
- * ```
- */
-export interface CKBoxAssetLinkAttributesDefinition {
-    /**
-     * A link name.
-     */
-    linkName: string;
-    /**
-     * An URL for the asset.
-     */
-    linkHref: string;
-}
-/**
- * The source set of the responsive image provided by the CKBox backend.
- *
- * Each numeric key corresponds to display width of the image.
- */
-export interface CKBoxImageUrls {
-    [width: number]: string;
-    /**
-     * A fallback URL for browsers that do not support the "webp" format.
-     */
-    default: string;
-}
-/**
- * Raw asset definition that is received from the CKBox feature.
- */
-export interface CKBoxRawAssetDefinition {
-    /**
-     * A raw asset data definition.
-     */
-    data: CKBoxRawAssetDataDefinition;
-}
-/**
- * Part of raw asset data that is received from the CKBox feature.
- */
-export interface CKBoxRawAssetDataDefinition {
-    /**
-     *  An unique asset id.
-     */
-    id: string;
-    /**
-     * An asset name.
-     */
-    name: string;
-    /**
-     *  A raw asset metadata definition.
-     */
-    metadata?: CKBoxRawAssetMetadataDefinition;
-    /**
-     * The source set of the responsive image.
-     */
-    imageUrls?: CKBoxImageUrls;
-    /**
-     * The asset location.
-     */
-    url: string;
-}
-/**
- * Part of raw asset data that is received from the CKBox feature. Properties are set only if the chosen asset is an image.
- */
-export interface CKBoxRawAssetMetadataDefinition {
-    /**
-     * Image description.
-     */
-    description?: string;
-    /**
-     * Image width.
-     */
-    width?: number;
-    /**
-     * Image height.
-     */
-    height?: number;
-    /**
-     * The blurhash placeholder value.
-     */
-    blurHash?: string;
-    /**
-     * The processing status of the asset.
-     */
-    metadataProcessingStatus?: string;
-}

package/dist/ckboxediting.d.ts

@@ -1,65 +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 ckbox/ckboxediting
- */
-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 {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CKBoxEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @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;
-    /**
-     * Blocks `uploadImage` and `ckboxImageEdit` commands.
-     */
-    private _blockImageCommands;
-    /**
-     * 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/ckboximageedit/ckboximageeditcommand.d.ts

@@ -1,109 +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 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;
-    /**
-    * CKBox's onClose function runs before the final cleanup, potentially causing
-    * page layout changes after it finishes. To address this, we use a setTimeout hack
-    * to ensure that floating elements on the page maintain their correct position.
-    *
-    * See: https://github.com/ckeditor/ckeditor5/issues/16153.
-    */
-    private _updateUiDelayed;
-    /**
-     * @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/ckboximageedit/ckboximageeditediting.d.ts

@@ -1,36 +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 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 isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CKBoxEditing, typeof CKBoxUtils, typeof PendingActions, typeof Notification, "ImageUtils", "ImageEditing"];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/ckboximageedit/ckboximageeditui.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-licensing-options
- */
-/**
- * @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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/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-licensing-options
- */
-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;