@ckeditor/ckeditor5-upload 38.1.1 → 38.2.0-alpha.1

package/src/adapters/simpleuploadadapter.js

@@ -1,175 +1,175 @@
-/**
- * @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 upload/adapters/simpleuploadadapter
- */
-/* globals XMLHttpRequest, FormData */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import FileRepository from '../filerepository';
-import { logWarning } from '@ckeditor/ckeditor5-utils';
-/**
- * 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
- * minimal {@link module:upload/uploadconfig~SimpleUploadConfig editor configuration}.
- *
- * ```ts
- * ClassicEditor
- * 	.create( document.querySelector( '#editor' ), {
- * 		simpleUpload: {
- * 			uploadUrl: 'http://example.com',
- * 			headers: {
- * 				...
- * 			}
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See the {@glink features/images/image-upload/simple-upload-adapter "Simple upload adapter"} guide to learn how to
- * learn more about the feature (configuration, server–side requirements, etc.).
- *
- * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload overview"} to learn about
- * other ways to upload images into CKEditor 5.
- */
-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/uploadconfig~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.
- */
-class Adapter {
-    /**
-     * Creates a new adapter instance.
-     */
-    constructor(loader, options) {
-        this.loader = loader;
-        this.options = options;
-    }
-    /**
-     * Starts the upload process.
-     *
-     * @see module:upload/filerepository~UploadAdapter#upload
-     */
-    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
-     */
-    abort() {
-        if (this.xhr) {
-            this.xhr.abort();
-        }
-    }
-    /**
-     * Initializes the `XMLHttpRequest` object using the URL specified as
-     * {@link module:upload/uploadconfig~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
-     * configuration.
-     */
-    _initRequest() {
-        const xhr = this.xhr = new XMLHttpRequest();
-        xhr.open('POST', this.options.uploadUrl, true);
-        xhr.responseType = 'json';
-    }
-    /**
-     * Initializes XMLHttpRequest listeners
-     *
-     * @param resolve Callback function to be called when the request is successful.
-     * @param reject Callback function to be called when the request cannot be completed.
-     * @param 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 -- @preserve */
-        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.
-     *
-     * @param 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);
-    }
-}
+/**
+ * @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 upload/adapters/simpleuploadadapter
+ */
+/* globals XMLHttpRequest, FormData */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import FileRepository from '../filerepository.js';
+import { logWarning } from '@ckeditor/ckeditor5-utils';
+/**
+ * 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
+ * minimal {@link module:upload/uploadconfig~SimpleUploadConfig editor configuration}.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( document.querySelector( '#editor' ), {
+ * 		simpleUpload: {
+ * 			uploadUrl: 'http://example.com',
+ * 			headers: {
+ * 				...
+ * 			}
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See the {@glink features/images/image-upload/simple-upload-adapter "Simple upload adapter"} guide to learn how to
+ * learn more about the feature (configuration, server–side requirements, etc.).
+ *
+ * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload overview"} to learn about
+ * other ways to upload images into CKEditor 5.
+ */
+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/uploadconfig~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.
+ */
+class Adapter {
+    /**
+     * Creates a new adapter instance.
+     */
+    constructor(loader, options) {
+        this.loader = loader;
+        this.options = options;
+    }
+    /**
+     * Starts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#upload
+     */
+    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
+     */
+    abort() {
+        if (this.xhr) {
+            this.xhr.abort();
+        }
+    }
+    /**
+     * Initializes the `XMLHttpRequest` object using the URL specified as
+     * {@link module:upload/uploadconfig~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
+     * configuration.
+     */
+    _initRequest() {
+        const xhr = this.xhr = new XMLHttpRequest();
+        xhr.open('POST', this.options.uploadUrl, true);
+        xhr.responseType = 'json';
+    }
+    /**
+     * Initializes XMLHttpRequest listeners
+     *
+     * @param resolve Callback function to be called when the request is successful.
+     * @param reject Callback function to be called when the request cannot be completed.
+     * @param 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 -- @preserve */
+        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.
+     *
+     * @param 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);
+    }
+}

package/src/augmentation.d.ts

@@ -1,20 +1,20 @@
-/**
- * @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
- */
-import type { SimpleUploadConfig, FileRepository, SimpleUploadAdapter, Base64UploadAdapter } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
-         *
-         * Read more in {@link module:upload/uploadconfig~SimpleUploadConfig}.
-         */
-        simpleUpload?: SimpleUploadConfig;
-    }
-    interface PluginsMap {
-        [FileRepository.pluginName]: FileRepository;
-        [SimpleUploadAdapter.pluginName]: SimpleUploadAdapter;
-        [Base64UploadAdapter.pluginName]: Base64UploadAdapter;
-    }
-}
+/**
+ * @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
+ */
+import type { SimpleUploadConfig, FileRepository, SimpleUploadAdapter, Base64UploadAdapter } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
+         *
+         * Read more in {@link module:upload/uploadconfig~SimpleUploadConfig}.
+         */
+        simpleUpload?: SimpleUploadConfig;
+    }
+    interface PluginsMap {
+        [FileRepository.pluginName]: FileRepository;
+        [SimpleUploadAdapter.pluginName]: SimpleUploadAdapter;
+        [Base64UploadAdapter.pluginName]: Base64UploadAdapter;
+    }
+}

package/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @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
- */
-export {};
+/**
+ * @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
+ */
+export {};

package/src/filereader.d.ts

@@ -1,56 +1,56 @@
-/**
- * @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
- */
-declare const FileReader_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
-/**
- * Wrapper over the native `FileReader`.
- */
-export default class FileReader extends FileReader_base {
-    total: number;
-    /**
-     * Instance of native FileReader.
-     */
-    private readonly _reader;
-    /**
-     * Holds the data of an already loaded file. The file must be first loaded
-     * by using {@link module:upload/filereader~FileReader#read `read()`}.
-     */
-    private _data?;
-    /**
-     * Number of bytes loaded.
-     *
-     * @readonly
-     * @observable
-     */
-    loaded: number;
-    /**
-     * Creates an instance of the FileReader.
-     */
-    constructor();
-    /**
-     * Returns error that occurred during file reading.
-     */
-    get error(): DOMException | null;
-    /**
-     * Holds the data of an already loaded file. The file must be first loaded
-     * by using {@link module:upload/filereader~FileReader#read `read()`}.
-     */
-    get data(): string | undefined;
-    /**
-     * Reads the provided file.
-     *
-     * @param file Native File object.
-     * @returns Returns a promise that will be resolved with file's content.
-     * The promise will be rejected in case of an error or when the reading process is aborted.
-     */
-    read(file: File): Promise<string>;
-    /**
-     * Aborts file reader.
-     */
-    abort(): void;
-}
-export {};
+/**
+ * @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
+ */
+declare const FileReader_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Observable;
+    prototype: import("@ckeditor/ckeditor5-utils").Observable;
+};
+/**
+ * Wrapper over the native `FileReader`.
+ */
+export default class FileReader extends FileReader_base {
+    total: number;
+    /**
+     * Instance of native FileReader.
+     */
+    private readonly _reader;
+    /**
+     * Holds the data of an already loaded file. The file must be first loaded
+     * by using {@link module:upload/filereader~FileReader#read `read()`}.
+     */
+    private _data?;
+    /**
+     * Number of bytes loaded.
+     *
+     * @readonly
+     * @observable
+     */
+    loaded: number;
+    /**
+     * Creates an instance of the FileReader.
+     */
+    constructor();
+    /**
+     * Returns error that occurred during file reading.
+     */
+    get error(): DOMException | null;
+    /**
+     * Holds the data of an already loaded file. The file must be first loaded
+     * by using {@link module:upload/filereader~FileReader#read `read()`}.
+     */
+    get data(): string | undefined;
+    /**
+     * Reads the provided file.
+     *
+     * @param file Native File object.
+     * @returns Returns a promise that will be resolved with file's content.
+     * The promise will be rejected in case of an error or when the reading process is aborted.
+     */
+    read(file: File): Promise<string>;
+    /**
+     * Aborts file reader.
+     */
+    abort(): void;
+}
+export {};

package/src/filereader.js

@@ -1,71 +1,71 @@
-/**
- * @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 upload/filereader
- */
-/* globals window */
-import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * Wrapper over the native `FileReader`.
- */
-export default class FileReader extends ObservableMixin() {
-    /**
-     * Creates an instance of the FileReader.
-     */
-    constructor() {
-        super();
-        const reader = new window.FileReader();
-        this._reader = reader;
-        this._data = undefined;
-        this.set('loaded', 0);
-        reader.onprogress = evt => {
-            this.loaded = evt.loaded;
-        };
-    }
-    /**
-     * Returns error that occurred during file reading.
-     */
-    get error() {
-        return this._reader.error;
-    }
-    /**
-     * Holds the data of an already loaded file. The file must be first loaded
-     * by using {@link module:upload/filereader~FileReader#read `read()`}.
-     */
-    get data() {
-        return this._data;
-    }
-    /**
-     * Reads the provided file.
-     *
-     * @param file Native File object.
-     * @returns Returns a promise that will be resolved with file's content.
-     * The promise will be rejected in case of an error or when the reading process is aborted.
-     */
-    read(file) {
-        const reader = this._reader;
-        this.total = file.size;
-        return new Promise((resolve, reject) => {
-            reader.onload = () => {
-                const result = reader.result;
-                this._data = result;
-                resolve(result);
-            };
-            reader.onerror = () => {
-                reject('error');
-            };
-            reader.onabort = () => {
-                reject('aborted');
-            };
-            this._reader.readAsDataURL(file);
-        });
-    }
-    /**
-     * Aborts file reader.
-     */
-    abort() {
-        this._reader.abort();
-    }
-}
+/**
+ * @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 upload/filereader
+ */
+/* globals window */
+import { ObservableMixin } from '@ckeditor/ckeditor5-utils';
+/**
+ * Wrapper over the native `FileReader`.
+ */
+export default class FileReader extends ObservableMixin() {
+    /**
+     * Creates an instance of the FileReader.
+     */
+    constructor() {
+        super();
+        const reader = new window.FileReader();
+        this._reader = reader;
+        this._data = undefined;
+        this.set('loaded', 0);
+        reader.onprogress = evt => {
+            this.loaded = evt.loaded;
+        };
+    }
+    /**
+     * Returns error that occurred during file reading.
+     */
+    get error() {
+        return this._reader.error;
+    }
+    /**
+     * Holds the data of an already loaded file. The file must be first loaded
+     * by using {@link module:upload/filereader~FileReader#read `read()`}.
+     */
+    get data() {
+        return this._data;
+    }
+    /**
+     * Reads the provided file.
+     *
+     * @param file Native File object.
+     * @returns Returns a promise that will be resolved with file's content.
+     * The promise will be rejected in case of an error or when the reading process is aborted.
+     */
+    read(file) {
+        const reader = this._reader;
+        this.total = file.size;
+        return new Promise((resolve, reject) => {
+            reader.onload = () => {
+                const result = reader.result;
+                this._data = result;
+                resolve(result);
+            };
+            reader.onerror = () => {
+                reject('error');
+            };
+            reader.onabort = () => {
+                reject('aborted');
+            };
+            this._reader.readAsDataURL(file);
+        });
+    }
+    /**
+     * Aborts file reader.
+     */
+    abort() {
+        this._reader.abort();
+    }
+}