@ckeditor/ckeditor5-easy-image 36.0.1 → 37.0.0-alpha.0

package/build/easy-image.js

@@ -1,4 +1,4 @@
 /*!
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
- */(()=>{var e={704:(e,t,r)=>{e.exports=r(79)("./src/core.js")},448:(e,t,r)=>{e.exports=r(79)("./src/upload.js")},209:(e,t,r)=>{e.exports=r(79)("./src/utils.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function r(o){var a=t[o];if(void 0!==a)return a.exports;var i=t[o]={exports:{}};return e[o](i,i.exports,r),i.exports}r.d=(e,t)=>{for(var o in t)r.o(t,o)&&!r.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},r.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{CloudServicesUploadAdapter:()=>i,EasyImage:()=>l});var e=r(704),t=r(209),a=r(448);class i extends e.Plugin{static get pluginName(){return"CloudServicesUploadAdapter"}static get requires(){return["CloudServices",a.FileRepository]}init(){const e=this.editor,t=e.plugins.get("CloudServices"),r=t.token,o=t.uploadUrl;r&&(this._uploadGateway=e.plugins.get("CloudServicesCore").createUploadGateway(r,o),e.plugins.get(a.FileRepository).createUploadAdapter=e=>new s(this._uploadGateway,e))}}class s{constructor(e,t){this.uploadGateway=e,this.loader=t}upload(){return this.loader.file.then((e=>(this.fileUploader=this.uploadGateway.upload(e),this.fileUploader.on("progress",((e,t)=>{this.loader.uploadTotal=t.total,this.loader.uploaded=t.uploaded})),this.fileUploader.send())))}abort(){this.fileUploader.abort()}}class l extends e.Plugin{static get requires(){return[i,"ImageUpload"]}init(){const e=this.editor;e.plugins.has("ImageBlockEditing")||e.plugins.has("ImageInlineEditing")||(0,t.logWarning)("easy-image-image-feature-missing",e)}static get pluginName(){return"EasyImage"}}})(),(window.CKEditor5=window.CKEditor5||{}).easyImage=o})();
+ */(()=>{var e={704:(e,t,r)=>{e.exports=r(79)("./src/core.js")},448:(e,t,r)=>{e.exports=r(79)("./src/upload.js")},209:(e,t,r)=>{e.exports=r(79)("./src/utils.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function r(o){var a=t[o];if(void 0!==a)return a.exports;var i=t[o]={exports:{}};return e[o](i,i.exports,r),i.exports}r.d=(e,t)=>{for(var o in t)r.o(t,o)&&!r.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},r.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{CloudServicesUploadAdapter:()=>i,EasyImage:()=>l});var e=r(704),t=r(209),a=r(448);class i extends e.Plugin{static get pluginName(){return"CloudServicesUploadAdapter"}static get requires(){return["CloudServices",a.FileRepository]}init(){const e=this.editor,t=e.plugins.get("CloudServices"),r=t.token,o=t.uploadUrl;if(!r)return;const i=e.plugins.get("CloudServicesCore");this._uploadGateway=i.createUploadGateway(r,o),e.plugins.get(a.FileRepository).createUploadAdapter=e=>new s(this._uploadGateway,e)}}class s{constructor(e,t){this.uploadGateway=e,this.loader=t}upload(){return this.loader.file.then((e=>(this.fileUploader=this.uploadGateway.upload(e),this.fileUploader.on("progress",((e,t)=>{this.loader.uploadTotal=t.total,this.loader.uploaded=t.uploaded})),this.fileUploader.send())))}abort(){this.fileUploader?.abort()}}class l extends e.Plugin{static get pluginName(){return"EasyImage"}static get requires(){return[i,"ImageUpload"]}init(){const e=this.editor;e.plugins.has("ImageBlockEditing")||e.plugins.has("ImageInlineEditing")||(0,t.logWarning)("easy-image-image-feature-missing",e)}}})(),(window.CKEditor5=window.CKEditor5||{}).easyImage=o})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-easy-image",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.0",
   "description": "Easy Image feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,19 +12,20 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.1"
+    "ckeditor5": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-clipboard": "^36.0.1",
-    "@ckeditor/ckeditor5-cloud-services": "^36.0.1",
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
-    "@ckeditor/ckeditor5-image": "^36.0.1",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
-    "@ckeditor/ckeditor5-upload": "^36.0.1",
-    "@ckeditor/ckeditor5-utils": "^36.0.1",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-cloud-services": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-upload": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -43,13 +44,17 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
   "scripts": {
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build",
     "dll:build": "webpack"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/cloudservicesuploadadapter.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+* @module easy-image/cloudservicesuploadadapter
+*/
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * A plugin that enables upload to [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/).
+ *
+ * It is mainly used by the {@link module:easy-image/easyimage~EasyImage} feature.
+ *
+ * After enabling this adapter you need to configure the CKEditor Cloud Services integration through
+ * {@link module:cloud-services/cloudservices~CloudServicesConfig `config.cloudServices`}.
+ */
+export default class CloudServicesUploadAdapter extends Plugin {
+    private _uploadGateway?;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'CloudServicesUploadAdapter';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [CloudServicesUploadAdapter.pluginName]: CloudServicesUploadAdapter;
+    }
+}

package/src/cloudservicesuploadadapter.js

@@ -2,14 +2,11 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
 * @module easy-image/cloudservicesuploadadapter
 */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { FileRepository } from 'ckeditor5/src/upload';
-
 /**
  * A plugin that enables upload to [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/).
  *
@@ -17,72 +14,54 @@ import { FileRepository } from 'ckeditor5/src/upload';
  *
  * After enabling this adapter you need to configure the CKEditor Cloud Services integration through
  * {@link module:cloud-services/cloudservices~CloudServicesConfig `config.cloudServices`}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class CloudServicesUploadAdapter extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'CloudServicesUploadAdapter';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ 'CloudServices', FileRepository ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		const cloudServices = editor.plugins.get( 'CloudServices' );
-
-		const token = cloudServices.token;
-		const uploadUrl = cloudServices.uploadUrl;
-
-		if ( !token ) {
-			return;
-		}
-
-		this._uploadGateway = editor.plugins.get( 'CloudServicesCore' ).createUploadGateway( token, uploadUrl );
-
-		editor.plugins.get( FileRepository ).createUploadAdapter = loader => {
-			return new Adapter( this._uploadGateway, loader );
-		};
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CloudServicesUploadAdapter';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return ['CloudServices', FileRepository];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const cloudServices = editor.plugins.get('CloudServices');
+        const token = cloudServices.token;
+        const uploadUrl = cloudServices.uploadUrl;
+        if (!token) {
+            return;
+        }
+        const cloudServicesCore = editor.plugins.get('CloudServicesCore');
+        this._uploadGateway = cloudServicesCore.createUploadGateway(token, uploadUrl);
+        editor.plugins.get(FileRepository).createUploadAdapter = loader => {
+            return new Adapter(this._uploadGateway, loader);
+        };
+    }
 }
-
-/**
- * @private
- */
 class Adapter {
-	constructor( uploadGateway, loader ) {
-		this.uploadGateway = uploadGateway;
-
-		this.loader = loader;
-	}
-
-	upload() {
-		return this.loader.file.then( file => {
-			this.fileUploader = this.uploadGateway.upload( file );
-
-			this.fileUploader.on( 'progress', ( evt, data ) => {
-				this.loader.uploadTotal = data.total;
-				this.loader.uploaded = data.uploaded;
-			} );
-
-			return this.fileUploader.send();
-		} );
-	}
-
-	abort() {
-		this.fileUploader.abort();
-	}
+    constructor(uploadGateway, loader) {
+        this.uploadGateway = uploadGateway;
+        this.loader = loader;
+    }
+    upload() {
+        return this.loader.file.then(file => {
+            this.fileUploader = this.uploadGateway.upload(file);
+            this.fileUploader.on('progress', (evt, data) => {
+                this.loader.uploadTotal = data.total;
+                this.loader.uploaded = data.uploaded;
+            });
+            return this.fileUploader.send();
+        });
+    }
+    abort() {
+        this.fileUploader?.abort();
+    }
 }
-

package/src/easyimage.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module easy-image/easyimage
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * The Easy Image feature, which makes the image upload in CKEditor 5 possible with virtually zero
+ * server setup. A part of the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/)
+ * family.
+ *
+ * This is a "glue" plugin which enables:
+ *
+ * * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter}.
+ *
+ * This plugin requires plugin to be present in the editor configuration:
+ *
+ * * {@link module:image/image~Image},
+ * * {@link module:image/imageupload~ImageUpload},
+ *
+ * See the {@glink features/images/image-upload/easy-image "Easy Image integration" guide} to learn how to configure
+ * and use this feature.
+ *
+ * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload" guide} to learn about
+ * other ways to upload images into CKEditor 5.
+ *
+ * **Note**: After enabling the Easy Image plugin you need to configure the
+ * [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/)
+ * integration through {@link module:cloud-services/cloudservices~CloudServicesConfig `config.cloudServices`}.
+ */
+export default class EasyImage extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'EasyImage';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [EasyImage.pluginName]: EasyImage;
+    }
+}

package/src/easyimage.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module easy-image/easyimage
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { logWarning } from 'ckeditor5/src/utils';
-
 import CloudServicesUploadAdapter from './cloudservicesuploadadapter';
-
 /**
  * The Easy Image feature, which makes the image upload in CKEditor 5 possible with virtually zero
  * server setup. A part of the [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/)
@@ -35,44 +31,39 @@ import CloudServicesUploadAdapter from './cloudservicesuploadadapter';
  * **Note**: After enabling the Easy Image plugin you need to configure the
  * [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/)
  * integration through {@link module:cloud-services/cloudservices~CloudServicesConfig `config.cloudServices`}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class EasyImage extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ CloudServicesUploadAdapter, 'ImageUpload' ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		if ( !editor.plugins.has( 'ImageBlockEditing' ) && !editor.plugins.has( 'ImageInlineEditing' ) ) {
-			/**
-			 * The Easy Image feature requires one of the following plugins to be loaded to work correctly:
-			 *
-			 * * {@link module:image/imageblock~ImageBlock},
-			 * * {@link module:image/imageinline~ImageInline},
-			 * * {@link module:image/image~Image} (loads both `ImageBlock` and `ImageInline`)
-			 *
-			 * Please make sure your editor configuration is correct.
-			 *
-			 * @error easy-image-image-feature-missing
-			 * @param {module:core/editor/editor~Editor} editor
-			 */
-			logWarning( 'easy-image-image-feature-missing', editor );
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'EasyImage';
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'EasyImage';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [CloudServicesUploadAdapter, 'ImageUpload'];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        if (!editor.plugins.has('ImageBlockEditing') && !editor.plugins.has('ImageInlineEditing')) {
+            /**
+             * The Easy Image feature requires one of the following plugins to be loaded to work correctly:
+             *
+             * * {@link module:image/imageblock~ImageBlock},
+             * * {@link module:image/imageinline~ImageInline},
+             * * {@link module:image/image~Image} (loads both `ImageBlock` and `ImageInline`)
+             *
+             * Please make sure your editor configuration is correct.
+             *
+             * @error easy-image-image-feature-missing
+             * @param {module:core/editor/editor~Editor} editor
+             */
+            logWarning('easy-image-image-feature-missing', editor);
+        }
+    }
 }

package/src/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module easy-image
+ */
+export { default as EasyImage } from './easyimage';
+export { default as CloudServicesUploadAdapter } from './cloudservicesuploadadapter';

package/src/index.js

@@ -2,10 +2,8 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module easy-image
  */
-
 export { default as EasyImage } from './easyimage';
 export { default as CloudServicesUploadAdapter } from './cloudservicesuploadadapter';