@ckeditor/ckeditor5-cloud-services 40.0.0 → 40.2.0

package/src/uploadgateway/fileuploader.js

@@ -1,183 +1,183 @@
-/**
- * @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 { EmitterMixin, CKEditorError } from 'ckeditor5/src/utils';
-const BASE64_HEADER_REG_EXP = /^data:(\S*?);base64,/;
-/**
- * FileUploader class used to upload single file.
- */
-export default class FileUploader extends EmitterMixin() {
-    /**
-     * Creates `FileUploader` instance.
-     *
-     * @param fileOrData A blob object or a data string encoded with Base64.
-     * @param token Token used for authentication.
-     * @param apiAddress API address.
-     */
-    constructor(fileOrData, token, apiAddress) {
-        super();
-        if (!fileOrData) {
-            /**
-             * File must be provided as the first argument.
-             *
-             * @error fileuploader-missing-file
-             */
-            throw new CKEditorError('fileuploader-missing-file', null);
-        }
-        if (!token) {
-            /**
-             * Token must be provided as the second argument.
-             *
-             * @error fileuploader-missing-token
-             */
-            throw new CKEditorError('fileuploader-missing-token', null);
-        }
-        if (!apiAddress) {
-            /**
-             * Api address must be provided as the third argument.
-             *
-             * @error fileuploader-missing-api-address
-             */
-            throw new CKEditorError('fileuploader-missing-api-address', null);
-        }
-        this.file = _isBase64(fileOrData) ? _base64ToBlob(fileOrData) : fileOrData;
-        this._token = token;
-        this._apiAddress = apiAddress;
-    }
-    /**
-     * Registers callback on `progress` event.
-     */
-    onProgress(callback) {
-        this.on('progress', (event, data) => callback(data));
-        return this;
-    }
-    /**
-     * Registers callback on `error` event. Event is called once when error occurs.
-     */
-    onError(callback) {
-        this.once('error', (event, data) => callback(data));
-        return this;
-    }
-    /**
-     * Aborts upload process.
-     */
-    abort() {
-        this.xhr.abort();
-    }
-    /**
-     * Sends XHR request to API.
-     */
-    send() {
-        this._prepareRequest();
-        this._attachXHRListeners();
-        return this._sendRequest();
-    }
-    /**
-     * Prepares XHR request.
-     */
-    _prepareRequest() {
-        const xhr = new XMLHttpRequest();
-        xhr.open('POST', this._apiAddress);
-        xhr.setRequestHeader('Authorization', this._token.value);
-        xhr.responseType = 'json';
-        this.xhr = xhr;
-    }
-    /**
-     * Attaches listeners to the XHR.
-     */
-    _attachXHRListeners() {
-        const xhr = this.xhr;
-        const onError = (message) => {
-            return () => this.fire('error', message);
-        };
-        xhr.addEventListener('error', onError('Network Error'));
-        xhr.addEventListener('abort', onError('Abort'));
-        /* istanbul ignore else -- @preserve */
-        if (xhr.upload) {
-            xhr.upload.addEventListener('progress', event => {
-                if (event.lengthComputable) {
-                    this.fire('progress', {
-                        total: event.total,
-                        uploaded: event.loaded
-                    });
-                }
-            });
-        }
-        xhr.addEventListener('load', () => {
-            const statusCode = xhr.status;
-            const xhrResponse = xhr.response;
-            if (statusCode < 200 || statusCode > 299) {
-                return this.fire('error', xhrResponse.message || xhrResponse.error);
-            }
-        });
-    }
-    /**
-     * Sends XHR request.
-     */
-    _sendRequest() {
-        const formData = new FormData();
-        const xhr = this.xhr;
-        formData.append('file', this.file);
-        return new Promise((resolve, reject) => {
-            xhr.addEventListener('load', () => {
-                const statusCode = xhr.status;
-                const xhrResponse = xhr.response;
-                if (statusCode < 200 || statusCode > 299) {
-                    if (xhrResponse.message) {
-                        /**
-                         * Uploading file failed.
-                         *
-                         * @error fileuploader-uploading-data-failed
-                         */
-                        return reject(new CKEditorError('fileuploader-uploading-data-failed', this, { message: xhrResponse.message }));
-                    }
-                    return reject(xhrResponse.error);
-                }
-                return resolve(xhrResponse);
-            });
-            xhr.addEventListener('error', () => reject(new Error('Network Error')));
-            xhr.addEventListener('abort', () => reject(new Error('Abort')));
-            xhr.send(formData);
-        });
-    }
-}
-/**
- * Transforms Base64 string data into file.
- *
- * @param base64 String data.
- */
-function _base64ToBlob(base64, sliceSize = 512) {
-    try {
-        const contentType = base64.match(BASE64_HEADER_REG_EXP)[1];
-        const base64Data = atob(base64.replace(BASE64_HEADER_REG_EXP, ''));
-        const byteArrays = [];
-        for (let offset = 0; offset < base64Data.length; offset += sliceSize) {
-            const slice = base64Data.slice(offset, offset + sliceSize);
-            const byteNumbers = new Array(slice.length);
-            for (let i = 0; i < slice.length; i++) {
-                byteNumbers[i] = slice.charCodeAt(i);
-            }
-            byteArrays.push(new Uint8Array(byteNumbers));
-        }
-        return new Blob(byteArrays, { type: contentType });
-    }
-    catch (error) {
-        /**
-         * Problem with decoding Base64 image data.
-         *
-         * @error fileuploader-decoding-image-data-error
-         */
-        throw new CKEditorError('fileuploader-decoding-image-data-error', null);
-    }
-}
-/**
- * Checks that string is Base64.
- */
-function _isBase64(string) {
-    if (typeof string !== 'string') {
-        return false;
-    }
-    const match = string.match(BASE64_HEADER_REG_EXP);
-    return !!(match && match.length);
-}
+/**
+ * @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 { EmitterMixin, CKEditorError } from 'ckeditor5/src/utils';
+const BASE64_HEADER_REG_EXP = /^data:(\S*?);base64,/;
+/**
+ * FileUploader class used to upload single file.
+ */
+export default class FileUploader extends EmitterMixin() {
+    /**
+     * Creates `FileUploader` instance.
+     *
+     * @param fileOrData A blob object or a data string encoded with Base64.
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    constructor(fileOrData, token, apiAddress) {
+        super();
+        if (!fileOrData) {
+            /**
+             * File must be provided as the first argument.
+             *
+             * @error fileuploader-missing-file
+             */
+            throw new CKEditorError('fileuploader-missing-file', null);
+        }
+        if (!token) {
+            /**
+             * Token must be provided as the second argument.
+             *
+             * @error fileuploader-missing-token
+             */
+            throw new CKEditorError('fileuploader-missing-token', null);
+        }
+        if (!apiAddress) {
+            /**
+             * Api address must be provided as the third argument.
+             *
+             * @error fileuploader-missing-api-address
+             */
+            throw new CKEditorError('fileuploader-missing-api-address', null);
+        }
+        this.file = _isBase64(fileOrData) ? _base64ToBlob(fileOrData) : fileOrData;
+        this._token = token;
+        this._apiAddress = apiAddress;
+    }
+    /**
+     * Registers callback on `progress` event.
+     */
+    onProgress(callback) {
+        this.on('progress', (event, data) => callback(data));
+        return this;
+    }
+    /**
+     * Registers callback on `error` event. Event is called once when error occurs.
+     */
+    onError(callback) {
+        this.once('error', (event, data) => callback(data));
+        return this;
+    }
+    /**
+     * Aborts upload process.
+     */
+    abort() {
+        this.xhr.abort();
+    }
+    /**
+     * Sends XHR request to API.
+     */
+    send() {
+        this._prepareRequest();
+        this._attachXHRListeners();
+        return this._sendRequest();
+    }
+    /**
+     * Prepares XHR request.
+     */
+    _prepareRequest() {
+        const xhr = new XMLHttpRequest();
+        xhr.open('POST', this._apiAddress);
+        xhr.setRequestHeader('Authorization', this._token.value);
+        xhr.responseType = 'json';
+        this.xhr = xhr;
+    }
+    /**
+     * Attaches listeners to the XHR.
+     */
+    _attachXHRListeners() {
+        const xhr = this.xhr;
+        const onError = (message) => {
+            return () => this.fire('error', message);
+        };
+        xhr.addEventListener('error', onError('Network Error'));
+        xhr.addEventListener('abort', onError('Abort'));
+        /* istanbul ignore else -- @preserve */
+        if (xhr.upload) {
+            xhr.upload.addEventListener('progress', event => {
+                if (event.lengthComputable) {
+                    this.fire('progress', {
+                        total: event.total,
+                        uploaded: event.loaded
+                    });
+                }
+            });
+        }
+        xhr.addEventListener('load', () => {
+            const statusCode = xhr.status;
+            const xhrResponse = xhr.response;
+            if (statusCode < 200 || statusCode > 299) {
+                return this.fire('error', xhrResponse.message || xhrResponse.error);
+            }
+        });
+    }
+    /**
+     * Sends XHR request.
+     */
+    _sendRequest() {
+        const formData = new FormData();
+        const xhr = this.xhr;
+        formData.append('file', this.file);
+        return new Promise((resolve, reject) => {
+            xhr.addEventListener('load', () => {
+                const statusCode = xhr.status;
+                const xhrResponse = xhr.response;
+                if (statusCode < 200 || statusCode > 299) {
+                    if (xhrResponse.message) {
+                        /**
+                         * Uploading file failed.
+                         *
+                         * @error fileuploader-uploading-data-failed
+                         */
+                        return reject(new CKEditorError('fileuploader-uploading-data-failed', this, { message: xhrResponse.message }));
+                    }
+                    return reject(xhrResponse.error);
+                }
+                return resolve(xhrResponse);
+            });
+            xhr.addEventListener('error', () => reject(new Error('Network Error')));
+            xhr.addEventListener('abort', () => reject(new Error('Abort')));
+            xhr.send(formData);
+        });
+    }
+}
+/**
+ * Transforms Base64 string data into file.
+ *
+ * @param base64 String data.
+ */
+function _base64ToBlob(base64, sliceSize = 512) {
+    try {
+        const contentType = base64.match(BASE64_HEADER_REG_EXP)[1];
+        const base64Data = atob(base64.replace(BASE64_HEADER_REG_EXP, ''));
+        const byteArrays = [];
+        for (let offset = 0; offset < base64Data.length; offset += sliceSize) {
+            const slice = base64Data.slice(offset, offset + sliceSize);
+            const byteNumbers = new Array(slice.length);
+            for (let i = 0; i < slice.length; i++) {
+                byteNumbers[i] = slice.charCodeAt(i);
+            }
+            byteArrays.push(new Uint8Array(byteNumbers));
+        }
+        return new Blob(byteArrays, { type: contentType });
+    }
+    catch (error) {
+        /**
+         * Problem with decoding Base64 image data.
+         *
+         * @error fileuploader-decoding-image-data-error
+         */
+        throw new CKEditorError('fileuploader-decoding-image-data-error', null);
+    }
+}
+/**
+ * Checks that string is Base64.
+ */
+function _isBase64(string) {
+    if (typeof string !== 'string') {
+        return false;
+    }
+    const match = string.match(BASE64_HEADER_REG_EXP);
+    return !!(match && match.length);
+}

package/src/uploadgateway/uploadgateway.d.ts

@@ -1,47 +1,47 @@
-/**
- * @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 cloud-services/uploadgateway/uploadgateway
- */
-import FileUploader from './fileuploader';
-import type { InitializedToken } from '../token/token';
-/**
- * UploadGateway abstracts file uploads to CKEditor Cloud Services.
- */
-export default class UploadGateway {
-    /**
-     * CKEditor Cloud Services access token.
-     */
-    private readonly _token;
-    /**
-     * CKEditor Cloud Services API address.
-     */
-    private readonly _apiAddress;
-    /**
-     * Creates `UploadGateway` instance.
-     *
-     * @param token Token used for authentication.
-     * @param apiAddress API address.
-     */
-    constructor(token: InitializedToken, apiAddress: string);
-    /**
-     * Creates a {@link module:cloud-services/uploadgateway/fileuploader~FileUploader} instance that wraps
-     * file upload process. The file is being sent at a time when the
-     * {@link module:cloud-services/uploadgateway/fileuploader~FileUploader#send} method is called.
-     *
-     * ```ts
-     * const token = await Token.create( 'https://token-endpoint' );
-     * new UploadGateway( token, 'https://example.org' )
-     * 	.upload( 'FILE' )
-     * 	.onProgress( ( data ) => console.log( data ) )
-     * 	.send()
-     * 	.then( ( response ) => console.log( response ) );
-     * ```
-     *
-     * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
-     * @returns {module:cloud-services/uploadgateway/fileuploader~FileUploader} Returns `FileUploader` instance.
-     */
-    upload(fileOrData: string | Blob): FileUploader;
-}
+/**
+ * @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 cloud-services/uploadgateway/uploadgateway
+ */
+import FileUploader from './fileuploader';
+import type { InitializedToken } from '../token/token';
+/**
+ * UploadGateway abstracts file uploads to CKEditor Cloud Services.
+ */
+export default class UploadGateway {
+    /**
+     * CKEditor Cloud Services access token.
+     */
+    private readonly _token;
+    /**
+     * CKEditor Cloud Services API address.
+     */
+    private readonly _apiAddress;
+    /**
+     * Creates `UploadGateway` instance.
+     *
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    constructor(token: InitializedToken, apiAddress: string);
+    /**
+     * Creates a {@link module:cloud-services/uploadgateway/fileuploader~FileUploader} instance that wraps
+     * file upload process. The file is being sent at a time when the
+     * {@link module:cloud-services/uploadgateway/fileuploader~FileUploader#send} method is called.
+     *
+     * ```ts
+     * const token = await Token.create( 'https://token-endpoint' );
+     * new UploadGateway( token, 'https://example.org' )
+     * 	.upload( 'FILE' )
+     * 	.onProgress( ( data ) => console.log( data ) )
+     * 	.send()
+     * 	.then( ( response ) => console.log( response ) );
+     * ```
+     *
+     * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
+     * @returns {module:cloud-services/uploadgateway/fileuploader~FileUploader} Returns `FileUploader` instance.
+     */
+    upload(fileOrData: string | Blob): FileUploader;
+}

package/src/uploadgateway/uploadgateway.js

@@ -1,60 +1,60 @@
-/**
- * @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 cloud-services/uploadgateway/uploadgateway
- */
-import FileUploader from './fileuploader';
-import { CKEditorError } from 'ckeditor5/src/utils';
-/**
- * UploadGateway abstracts file uploads to CKEditor Cloud Services.
- */
-export default class UploadGateway {
-    /**
-     * Creates `UploadGateway` instance.
-     *
-     * @param token Token used for authentication.
-     * @param apiAddress API address.
-     */
-    constructor(token, apiAddress) {
-        if (!token) {
-            /**
-             * Token must be provided.
-             *
-             * @error uploadgateway-missing-token
-             */
-            throw new CKEditorError('uploadgateway-missing-token', null);
-        }
-        if (!apiAddress) {
-            /**
-             * Api address must be provided.
-             *
-             * @error uploadgateway-missing-api-address
-             */
-            throw new CKEditorError('uploadgateway-missing-api-address', null);
-        }
-        this._token = token;
-        this._apiAddress = apiAddress;
-    }
-    /**
-     * Creates a {@link module:cloud-services/uploadgateway/fileuploader~FileUploader} instance that wraps
-     * file upload process. The file is being sent at a time when the
-     * {@link module:cloud-services/uploadgateway/fileuploader~FileUploader#send} method is called.
-     *
-     * ```ts
-     * const token = await Token.create( 'https://token-endpoint' );
-     * new UploadGateway( token, 'https://example.org' )
-     * 	.upload( 'FILE' )
-     * 	.onProgress( ( data ) => console.log( data ) )
-     * 	.send()
-     * 	.then( ( response ) => console.log( response ) );
-     * ```
-     *
-     * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
-     * @returns {module:cloud-services/uploadgateway/fileuploader~FileUploader} Returns `FileUploader` instance.
-     */
-    upload(fileOrData) {
-        return new FileUploader(fileOrData, this._token, this._apiAddress);
-    }
-}
+/**
+ * @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 cloud-services/uploadgateway/uploadgateway
+ */
+import FileUploader from './fileuploader';
+import { CKEditorError } from 'ckeditor5/src/utils';
+/**
+ * UploadGateway abstracts file uploads to CKEditor Cloud Services.
+ */
+export default class UploadGateway {
+    /**
+     * Creates `UploadGateway` instance.
+     *
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    constructor(token, apiAddress) {
+        if (!token) {
+            /**
+             * Token must be provided.
+             *
+             * @error uploadgateway-missing-token
+             */
+            throw new CKEditorError('uploadgateway-missing-token', null);
+        }
+        if (!apiAddress) {
+            /**
+             * Api address must be provided.
+             *
+             * @error uploadgateway-missing-api-address
+             */
+            throw new CKEditorError('uploadgateway-missing-api-address', null);
+        }
+        this._token = token;
+        this._apiAddress = apiAddress;
+    }
+    /**
+     * Creates a {@link module:cloud-services/uploadgateway/fileuploader~FileUploader} instance that wraps
+     * file upload process. The file is being sent at a time when the
+     * {@link module:cloud-services/uploadgateway/fileuploader~FileUploader#send} method is called.
+     *
+     * ```ts
+     * const token = await Token.create( 'https://token-endpoint' );
+     * new UploadGateway( token, 'https://example.org' )
+     * 	.upload( 'FILE' )
+     * 	.onProgress( ( data ) => console.log( data ) )
+     * 	.send()
+     * 	.then( ( response ) => console.log( response ) );
+     * ```
+     *
+     * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
+     * @returns {module:cloud-services/uploadgateway/fileuploader~FileUploader} Returns `FileUploader` instance.
+     */
+    upload(fileOrData) {
+        return new FileUploader(fileOrData, this._token, this._apiAddress);
+    }
+}