@ckeditor/ckeditor5-ckbox 41.1.0 → 41.3.0-alpha.0

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

@@ -0,0 +1,24 @@
+/**
+ * @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

@@ -0,0 +1,10 @@
+/**
+ * @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

@@ -0,0 +1,24 @@
+/**
+ * @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

@@ -0,0 +1,21 @@
+/**
+ * @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

@@ -0,0 +1,33 @@
+/**
+ * @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

@@ -0,0 +1,50 @@
+/**
+ * @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

@@ -0,0 +1,17 @@
+/**
+ * @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

@@ -0,0 +1,63 @@
+/**
+ * @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;

package/lang/translations/he.po

@@ -14,7 +14,7 @@ msgid ""
 msgstr ""
 "Language-Team: Hebrew (https://app.transifex.com/ckeditor/teams/11143/he/)\n"
 "Language: he\n"
-"Plural-Forms: nplurals=4; plural=(n == 1 && n % 1 == 0) ? 0 : (n == 2 && n % 1 == 0) ? 1: (n % 10 == 0 && n % 1 == 0 && n > 10) ? 2 : 3;\n"
+"Plural-Forms: nplurals=3; plural=(n == 1 && n % 1 == 0) ? 0 : (n == 2 && n % 1 == 0) ? 1: 2;\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 
 msgctxt "A toolbar button tooltip for opening the file browser that allows inserting an image or a file to the editor."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-ckbox",
-  "version": "41.1.0",
+  "version": "41.3.0-alpha.0",
   "description": "CKBox integration for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,7 +13,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.1.0",
+    "ckeditor5": "41.3.0-alpha.0",
     "blurhash": "2.0.5",
     "lodash-es": "4.17.21"
   },
@@ -27,6 +27,7 @@
     "directory": "packages/ckeditor5-ckbox"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/src/ckboxediting.d.ts

@@ -26,6 +26,15 @@ export default class CKBoxEditing extends Plugin {
      * @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.
      */

package/src/ckboxediting.js

@@ -30,14 +30,23 @@ export default class CKBoxEditing extends Plugin {
      */
     init() {
         const editor = this.editor;
-        const hasConfiguration = !!editor.config.get('ckbox');
-        const isLibraryLoaded = !!window.CKBox;
-        // Proceed with plugin initialization only when the integrator intentionally wants to use it, i.e. when the `config.ckbox` exists or
-        // the CKBox JavaScript library is loaded.
-        if (!hasConfiguration && !isLibraryLoaded) {
+        if (!this._shouldBeInitialised()) {
             return;
         }
         this._checkImagePlugins();
+        // Registering the `ckbox` command makes sense only if the CKBox library is loaded, as the `ckbox` command opens the CKBox dialog.
+        if (isLibraryLoaded()) {
+            editor.commands.add('ckbox', new CKBoxCommand(editor));
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        const editor = this.editor;
+        if (!this._shouldBeInitialised()) {
+            return;
+        }
         // Extending the schema, registering converters and applying fixers only make sense if the configuration option to assign
         // the assets ID with the model elements is enabled.
         if (!editor.config.get('ckbox.ignoreDataId')) {
@@ -45,10 +54,15 @@ export default class CKBoxEditing extends Plugin {
             this._initConversion();
             this._initFixers();
         }
-        // Registering the `ckbox` command makes sense only if the CKBox library is loaded, as the `ckbox` command opens the CKBox dialog.
-        if (isLibraryLoaded) {
-            editor.commands.add('ckbox', new CKBoxCommand(editor));
-        }
+    }
+    /**
+     * 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.
+     */
+    _shouldBeInitialised() {
+        const editor = this.editor;
+        const hasConfiguration = !!editor.config.get('ckbox');
+        return hasConfiguration || isLibraryLoaded();
     }
     /**
      * Checks if at least one image plugin is loaded.
@@ -319,3 +333,9 @@ function shouldUpcastAttributeForNode(node) {
     }
     return false;
 }
+/**
+ * Returns true if the CKBox library is loaded, false otherwise.
+ */
+function isLibraryLoaded() {
+    return !!window.CKBox;
+}

package/src/ckboxui.js

@@ -22,14 +22,15 @@ export default class CKBoxUI extends Plugin {
      */
     afterInit() {
         const editor = this.editor;
-        const command = editor.commands.get('ckbox');
         // Do not register the `ckbox` button if the command does not exist.
-        if (!command) {
+        // This might happen when CKBox library is not loaded on the page.
+        if (!editor.commands.get('ckbox')) {
             return;
         }
         const t = editor.t;
         const componentFactory = editor.ui.componentFactory;
         componentFactory.add('ckbox', locale => {
+            const command = editor.commands.get('ckbox');
             const button = new ButtonView(locale);
             button.set({
                 label: t('Open file manager'),
@@ -46,7 +47,7 @@ export default class CKBoxUI extends Plugin {
             const imageInsertUI = editor.plugins.get('ImageInsertUI');
             imageInsertUI.registerIntegration({
                 name: 'assetManager',
-                observable: command,
+                observable: () => editor.commands.get('ckbox'),
                 buttonViewCreator: () => {
                     const button = this.editor.ui.componentFactory.create('ckbox');
                     button.icon = icons.imageAssetManager;