@ckeditor/ckeditor5-upload 35.2.1 → 35.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-upload",
-  "version": "35.2.1",
+  "version": "35.3.0",
   "description": "Upload feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,9 +11,14 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^35.2.1",
-    "@ckeditor/ckeditor5-utils": "^35.2.1",
-    "@ckeditor/ckeditor5-ui": "^35.2.1"
+    "@ckeditor/ckeditor5-core": "^35.3.0",
+    "@ckeditor/ckeditor5-utils": "^35.3.0",
+    "@ckeditor/ckeditor5-ui": "^35.3.0"
+  },
+  "devDependencies": {
+    "typescript": "^4.8.4",
+    "webpack": "^5.58.1",
+    "webpack-cli": "^4.9.0"
   },
   "engines": {
     "node": ">=14.0.0",
@@ -30,9 +35,14 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
-  ]
+  ],
+  "scripts": {
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build"
+  }
 }

package/src/adapters/base64uploadadapter.js

@@ -2,16 +2,12 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module upload/adapters/base64uploadadapter
  */
-
 /* globals window */
-
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import FileRepository from '../filerepository';
-
 /**
  * A plugin that converts images inserted into the editor into [Base64 strings](https://en.wikipedia.org/wiki/Base64)
  * in the {@glink installation/advanced/saving-data editor output}.
@@ -25,28 +21,25 @@ import FileRepository from '../filerepository';
  * @extends module:core/plugin~Plugin
  */
 export default class Base64UploadAdapter extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ FileRepository ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'Base64UploadAdapter';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		this.editor.plugins.get( FileRepository ).createUploadAdapter = loader => new Adapter( loader );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FileRepository];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Base64UploadAdapter';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        this.editor.plugins.get(FileRepository).createUploadAdapter = loader => new Adapter(loader);
+    }
 }
-
 /**
  * The upload adapter that converts images inserted into the editor into Base64 strings.
  *
@@ -54,55 +47,49 @@ export default class Base64UploadAdapter extends Plugin {
  * @implements module:upload/filerepository~UploadAdapter
  */
 class Adapter {
-	/**
-	 * Creates a new adapter instance.
-	 *
-	 * @param {module:upload/filerepository~FileLoader} loader
-	 */
-	constructor( loader ) {
-		/**
-		 * `FileLoader` instance to use during the upload.
-		 *
-		 * @member {module:upload/filerepository~FileLoader} #loader
-		 */
-		this.loader = loader;
-	}
-
-	/**
-	 * Starts the upload process.
-	 *
-	 * @see module:upload/filerepository~UploadAdapter#upload
-	 * @returns {Promise}
-	 */
-	upload() {
-		return new Promise( ( resolve, reject ) => {
-			const reader = this.reader = new window.FileReader();
-
-			reader.addEventListener( 'load', () => {
-				resolve( { default: reader.result } );
-			} );
-
-			reader.addEventListener( 'error', err => {
-				reject( err );
-			} );
-
-			reader.addEventListener( 'abort', () => {
-				reject();
-			} );
-
-			this.loader.file.then( file => {
-				reader.readAsDataURL( file );
-			} );
-		} );
-	}
-
-	/**
-	 * Aborts the upload process.
-	 *
-	 * @see module:upload/filerepository~UploadAdapter#abort
-	 * @returns {Promise}
-	 */
-	abort() {
-		this.reader.abort();
-	}
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param {module:upload/filerepository~FileLoader} loader
+     */
+    constructor(loader) {
+        /**
+         * `FileLoader` instance to use during the upload.
+         *
+         * @member {module:upload/filerepository~FileLoader} #loader
+         */
+        this.loader = loader;
+    }
+    /**
+     * Starts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#upload
+     * @returns {Promise}
+     */
+    upload() {
+        return new Promise((resolve, reject) => {
+            const reader = this.reader = new window.FileReader();
+            reader.addEventListener('load', () => {
+                resolve({ default: reader.result });
+            });
+            reader.addEventListener('error', err => {
+                reject(err);
+            });
+            reader.addEventListener('abort', () => {
+                reject();
+            });
+            this.loader.file.then(file => {
+                reader.readAsDataURL(file);
+            });
+        });
+    }
+    /**
+     * Aborts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#abort
+     * @returns {Promise}
+     */
+    abort() {
+        this.reader.abort();
+    }
 }

package/src/adapters/simpleuploadadapter.js

@@ -2,17 +2,13 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module upload/adapters/simpleuploadadapter
  */
-
 /* globals XMLHttpRequest, FormData */
-
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import FileRepository from '../filerepository';
 import { logWarning } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
 /**
  * The Simple upload adapter allows uploading images to an application running on your server using
  * the [`XMLHttpRequest`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) API with a
@@ -39,49 +35,42 @@ import { logWarning } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  * @extends module:core/plugin~Plugin
  */
 export default class SimpleUploadAdapter extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ FileRepository ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'SimpleUploadAdapter';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const options = this.editor.config.get( 'simpleUpload' );
-
-		if ( !options ) {
-			return;
-		}
-
-		if ( !options.uploadUrl ) {
-			/**
-			 * The {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `config.simpleUpload.uploadUrl`}
-			 * configuration required by the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter `SimpleUploadAdapter`}
-			 * is missing. Make sure the correct URL is specified for the image upload to work properly.
-			 *
-			 * @error simple-upload-adapter-missing-uploadurl
-			 */
-			logWarning( 'simple-upload-adapter-missing-uploadurl' );
-
-			return;
-		}
-
-		this.editor.plugins.get( FileRepository ).createUploadAdapter = loader => {
-			return new Adapter( loader, options );
-		};
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FileRepository];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SimpleUploadAdapter';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const options = this.editor.config.get('simpleUpload');
+        if (!options) {
+            return;
+        }
+        if (!options.uploadUrl) {
+            /**
+             * The {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `config.simpleUpload.uploadUrl`}
+             * configuration required by the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter `SimpleUploadAdapter`}
+             * is missing. Make sure the correct URL is specified for the image upload to work properly.
+             *
+             * @error simple-upload-adapter-missing-uploadurl
+             */
+            logWarning('simple-upload-adapter-missing-uploadurl');
+            return;
+        }
+        this.editor.plugins.get(FileRepository).createUploadAdapter = loader => {
+            return new Adapter(loader, options);
+        };
+    }
 }
-
 /**
  * Upload adapter.
  *
@@ -89,228 +78,120 @@ export default class SimpleUploadAdapter extends Plugin {
  * @implements module:upload/filerepository~UploadAdapter
  */
 class Adapter {
-	/**
-	 * Creates a new adapter instance.
-	 *
-	 * @param {module:upload/filerepository~FileLoader} loader
-	 * @param {module:upload/adapters/simpleuploadadapter~SimpleUploadConfig} options
-	 */
-	constructor( loader, options ) {
-		/**
-		 * FileLoader instance to use during the upload.
-		 *
-		 * @member {module:upload/filerepository~FileLoader} #loader
-		 */
-		this.loader = loader;
-
-		/**
-		 * The configuration of the adapter.
-		 *
-		 * @member {module:upload/adapters/simpleuploadadapter~SimpleUploadConfig} #options
-		 */
-		this.options = options;
-	}
-
-	/**
-	 * Starts the upload process.
-	 *
-	 * @see module:upload/filerepository~UploadAdapter#upload
-	 * @returns {Promise}
-	 */
-	upload() {
-		return this.loader.file
-			.then( file => new Promise( ( resolve, reject ) => {
-				this._initRequest();
-				this._initListeners( resolve, reject, file );
-				this._sendRequest( file );
-			} ) );
-	}
-
-	/**
-	 * Aborts the upload process.
-	 *
-	 * @see module:upload/filerepository~UploadAdapter#abort
-	 * @returns {Promise}
-	 */
-	abort() {
-		if ( this.xhr ) {
-			this.xhr.abort();
-		}
-	}
-
-	/**
-	 * Initializes the `XMLHttpRequest` object using the URL specified as
-	 * {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
-	 * configuration.
-	 *
-	 * @private
-	 */
-	_initRequest() {
-		const xhr = this.xhr = new XMLHttpRequest();
-
-		xhr.open( 'POST', this.options.uploadUrl, true );
-		xhr.responseType = 'json';
-	}
-
-	/**
-	 * Initializes XMLHttpRequest listeners
-	 *
-	 * @private
-	 * @param {Function} resolve Callback function to be called when the request is successful.
-	 * @param {Function} reject Callback function to be called when the request cannot be completed.
-	 * @param {File} file Native File object.
-	 */
-	_initListeners( resolve, reject, file ) {
-		const xhr = this.xhr;
-		const loader = this.loader;
-		const genericErrorText = `Couldn't upload file: ${ file.name }.`;
-
-		xhr.addEventListener( 'error', () => reject( genericErrorText ) );
-		xhr.addEventListener( 'abort', () => reject() );
-		xhr.addEventListener( 'load', () => {
-			const response = xhr.response;
-
-			if ( !response || response.error ) {
-				return reject( response && response.error && response.error.message ? response.error.message : genericErrorText );
-			}
-
-			const urls = response.url ? { default: response.url } : response.urls;
-
-			// Resolve with the normalized `urls` property and pass the rest of the response
-			// to allow customizing the behavior of features relying on the upload adapters.
-			resolve( {
-				...response,
-				urls
-			} );
-		} );
-
-		// Upload progress when it is supported.
-		/* istanbul ignore else */
-		if ( xhr.upload ) {
-			xhr.upload.addEventListener( 'progress', evt => {
-				if ( evt.lengthComputable ) {
-					loader.uploadTotal = evt.total;
-					loader.uploaded = evt.loaded;
-				}
-			} );
-		}
-	}
-
-	/**
-	 * Prepares the data and sends the request.
-	 *
-	 * @private
-	 * @param {File} file File instance to be uploaded.
-	 */
-	_sendRequest( file ) {
-		// Set headers if specified.
-		const headers = this.options.headers || {};
-
-		// Use the withCredentials flag if specified.
-		const withCredentials = this.options.withCredentials || false;
-
-		for ( const headerName of Object.keys( headers ) ) {
-			this.xhr.setRequestHeader( headerName, headers[ headerName ] );
-		}
-
-		this.xhr.withCredentials = withCredentials;
-
-		// Prepare the form data.
-		const data = new FormData();
-
-		data.append( 'upload', file );
-
-		// Send the request.
-		this.xhr.send( data );
-	}
+    /**
+     * Creates a new adapter instance.
+     *
+     * @param {module:upload/filerepository~FileLoader} loader
+     * @param {module:upload/adapters/simpleuploadadapter~SimpleUploadConfig} options
+     */
+    constructor(loader, options) {
+        /**
+         * FileLoader instance to use during the upload.
+         *
+         * @member {module:upload/filerepository~FileLoader} #loader
+         */
+        this.loader = loader;
+        /**
+         * The configuration of the adapter.
+         *
+         * @member {module:upload/adapters/simpleuploadadapter~SimpleUploadConfig} #options
+         */
+        this.options = options;
+    }
+    /**
+     * Starts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#upload
+     * @returns {Promise}
+     */
+    upload() {
+        return this.loader.file
+            .then(file => new Promise((resolve, reject) => {
+            this._initRequest();
+            this._initListeners(resolve, reject, file);
+            this._sendRequest(file);
+        }));
+    }
+    /**
+     * Aborts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#abort
+     * @returns {Promise}
+     */
+    abort() {
+        if (this.xhr) {
+            this.xhr.abort();
+        }
+    }
+    /**
+     * Initializes the `XMLHttpRequest` object using the URL specified as
+     * {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
+     * configuration.
+     *
+     * @private
+     */
+    _initRequest() {
+        const xhr = this.xhr = new XMLHttpRequest();
+        xhr.open('POST', this.options.uploadUrl, true);
+        xhr.responseType = 'json';
+    }
+    /**
+     * Initializes XMLHttpRequest listeners
+     *
+     * @private
+     * @param {Function} resolve Callback function to be called when the request is successful.
+     * @param {Function} reject Callback function to be called when the request cannot be completed.
+     * @param {File} file Native File object.
+     */
+    _initListeners(resolve, reject, file) {
+        const xhr = this.xhr;
+        const loader = this.loader;
+        const genericErrorText = `Couldn't upload file: ${file.name}.`;
+        xhr.addEventListener('error', () => reject(genericErrorText));
+        xhr.addEventListener('abort', () => reject());
+        xhr.addEventListener('load', () => {
+            const response = xhr.response;
+            if (!response || response.error) {
+                return reject(response && response.error && response.error.message ? response.error.message : genericErrorText);
+            }
+            const urls = response.url ? { default: response.url } : response.urls;
+            // Resolve with the normalized `urls` property and pass the rest of the response
+            // to allow customizing the behavior of features relying on the upload adapters.
+            resolve({
+                ...response,
+                urls
+            });
+        });
+        // Upload progress when it is supported.
+        /* istanbul ignore else */
+        if (xhr.upload) {
+            xhr.upload.addEventListener('progress', evt => {
+                if (evt.lengthComputable) {
+                    loader.uploadTotal = evt.total;
+                    loader.uploaded = evt.loaded;
+                }
+            });
+        }
+    }
+    /**
+     * Prepares the data and sends the request.
+     *
+     * @private
+     * @param {File} file File instance to be uploaded.
+     */
+    _sendRequest(file) {
+        // Set headers if specified.
+        const headers = this.options.headers || {};
+        // Use the withCredentials flag if specified.
+        const withCredentials = this.options.withCredentials || false;
+        for (const headerName of Object.keys(headers)) {
+            this.xhr.setRequestHeader(headerName, headers[headerName]);
+        }
+        this.xhr.withCredentials = withCredentials;
+        // Prepare the form data.
+        const data = new FormData();
+        data.append('upload', file);
+        // Send the request.
+        this.xhr.send(data);
+    }
 }
-
-/**
- * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				simpleUpload: {
- *					// The URL the images are uploaded to.
- *					uploadUrl: 'http://example.com',
- *
- *					// Headers sent along with the XMLHttpRequest to the upload server.
- *					headers: {
- *						...
- *					}
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * See the {@glink features/images/image-upload/simple-upload-adapter "Simple upload adapter"} guide to learn more.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
- *
- * @interface SimpleUploadConfig
- */
-
-/**
- * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
- *
- * Read more in {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig}.
- *
- * @member {module:upload/adapters/simpleuploadadapter~SimpleUploadConfig} module:core/editor/editorconfig~EditorConfig#simpleUpload
- */
-
-/**
- * The path (URL) to the server (application) which handles the file upload. When specified, enables the automatic
- * upload of resources (images) inserted into the editor content.
- *
- * Learn more about the server application requirements in the
- * {@glink features/images/image-upload/simple-upload-adapter#server-side-configuration "Server-side configuration"} section
- * of the feature guide.
- *
- * @member {String} module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl
- */
-
-/**
- * An object that defines additional [headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers) sent with
- * the request to the server during the upload. This is the right place to implement security mechanisms like
- * authentication and [CSRF](https://developer.mozilla.org/en-US/docs/Glossary/CSRF) protection.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				simpleUpload: {
- *					headers: {
- *						'X-CSRF-TOKEN': 'CSRF-Token',
- *						Authorization: 'Bearer <JSON Web Token>'
- *					}
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * Learn more about the server application requirements in the
- * {@glink features/images/image-upload/simple-upload-adapter#server-side-configuration "Server-side configuration"} section
- * of the feature guide.
- *
- * @member {Object.<String, String>} module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#headers
- */
-
-/**
- * This flag enables the
- * [`withCredentials`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials)
- * property of the request sent to the server during the upload. It affects cross-site requests only and, for instance,
- * allows credentials such as cookies to be sent along with the request.
- *
- *		ClassicEditor
- *			.create( editorElement, {
- *				simpleUpload: {
- *					withCredentials: true
- *				}
- *			} );
- *			.then( ... )
- *			.catch( ... );
- *
- * Learn more about the server application requirements in the
- * {@glink features/images/image-upload/simple-upload-adapter#server-side-configuration "Server-side configuration"} section
- * of the feature guide.
- *
- * @member {Boolean} [module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#withCredentials=false]
- */