@ckeditor/ckeditor5-ckbox 0.0.0-nightly-20250121.0 → 0.0.0-nightly-20250123.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-ckbox",
-  "version": "0.0.0-nightly-20250121.0",
+  "version": "0.0.0-nightly-20250123.0",
   "description": "CKBox integration for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,12 +13,14 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20250121.0",
-    "@ckeditor/ckeditor5-engine": "0.0.0-nightly-20250121.0",
-    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20250121.0",
-    "@ckeditor/ckeditor5-upload": "0.0.0-nightly-20250121.0",
-    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20250121.0",
-    "ckeditor5": "0.0.0-nightly-20250121.0",
+    "@ckeditor/ckeditor5-cloud-services": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-engine": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-image": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-upload": "0.0.0-nightly-20250123.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20250123.0",
+    "ckeditor5": "0.0.0-nightly-20250123.0",
     "blurhash": "2.0.5",
     "lodash-es": "4.17.21"
   },

package/src/ckboxcommand.js

@@ -154,6 +154,7 @@ export default class CKBoxCommand extends Command {
         const editor = this.editor;
         const model = editor.model;
         const shouldInsertDataId = !editor.config.get('ckbox.ignoreDataId');
+        const downloadableFilesConfig = editor.config.get('ckbox.downloadableFiles');
         // Refresh the command after firing the `ckbox:*` event.
         this.on('ckbox', () => {
             this.refresh();
@@ -185,6 +186,7 @@ export default class CKBoxCommand extends Command {
             const linkCommand = editor.commands.get('link');
             const assetsToProcess = prepareAssets({
                 assets,
+                downloadableFilesConfig,
                 isImageAllowed: imageCommand.isEnabled,
                 isLinkAllowed: linkCommand.isEnabled
             });
@@ -298,7 +300,7 @@ export default class CKBoxCommand extends Command {
 /**
  * Parses the chosen assets into the internal data format. Filters out chosen assets that are not allowed.
  */
-function prepareAssets({ assets, isImageAllowed, isLinkAllowed }) {
+function prepareAssets({ downloadableFilesConfig, assets, isImageAllowed, isLinkAllowed }) {
     return assets
         .map(asset => isImage(asset) ?
         {
@@ -309,7 +311,7 @@ function prepareAssets({ assets, isImageAllowed, isLinkAllowed }) {
         {
             id: asset.data.id,
             type: 'link',
-            attributes: prepareLinkAssetAttributes(asset)
+            attributes: prepareLinkAssetAttributes(asset, downloadableFilesConfig)
         })
         .filter(asset => asset.type === 'image' ? isImageAllowed : isLinkAllowed);
 }
@@ -334,12 +336,13 @@ export function prepareImageAssetAttributes(asset) {
 /**
  * Parses the assets attributes into the internal data format.
  *
- * @param origin The base URL for assets inserted into the editor.
+ * @param asset The asset to prepare the attributes for.
+ * @param config The CKBox download asset configuration.
  */
-function prepareLinkAssetAttributes(asset) {
+function prepareLinkAssetAttributes(asset, config) {
     return {
         linkName: asset.data.name,
-        linkHref: getAssetUrl(asset)
+        linkHref: getAssetUrl(asset, config)
     };
 }
 /**
@@ -355,10 +358,25 @@ function isImage(asset) {
 /**
  * Creates the URL for the asset.
  *
- * @param origin The base URL for assets inserted into the editor.
+ * @param asset The asset to create the URL for.
+ * @param config The CKBox download asset configuration.
  */
-function getAssetUrl(asset) {
+function getAssetUrl(asset, config) {
     const url = new URL(asset.data.url);
-    url.searchParams.set('download', 'true');
+    if (isDownloadableAsset(asset, config)) {
+        url.searchParams.set('download', 'true');
+    }
     return url.toString();
 }
+/**
+ * Determines if download should be enabled for given asset based on configuration.
+ *
+ * @param asset The asset to check.
+ * @param config The CKBox download asset configuration.
+ */
+function isDownloadableAsset(asset, config) {
+    if (typeof config === 'function') {
+        return config(asset);
+    }
+    return true;
+}

package/src/ckboxconfig.d.ts

@@ -156,6 +156,18 @@ export interface CKBoxConfig {
      * ```
      */
     choosableFileExtensions?: Array<string>;
+    /**
+     * Controls when to enable the download attribute for inserted links.
+     *
+     * By default, files are downloadable.
+     *
+     * ```ts
+     * const ckboxConfig = {
+     *   downloadableFiles: asset => asset.data.extension !== 'pdf'
+     * };
+     * ```
+     */
+    downloadableFiles?: (asset: CKBoxRawAssetDefinition) => boolean;
 }
 export interface CKBoxDialogConfig {
     /**
@@ -402,6 +414,10 @@ export interface CKBoxRawAssetDataDefinition {
      * The asset location.
      */
     url: string;
+    /**
+     * The asset type.
+     */
+    extension?: string;
 }
 /**
  * Part of raw asset data that is received from the CKBox feature. Properties are set only if the chosen asset is an image.