@ckeditor/ckeditor5-upload 40.0.0 → 40.2.0

package/src/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * @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
- */
-export { default as FileRepository, type UploadAdapter, type UploadResponse, type FileLoader } from './filerepository';
-export { default as FileDialogButtonView } from './ui/filedialogbuttonview';
-export { default as Base64UploadAdapter } from './adapters/base64uploadadapter';
-export { default as SimpleUploadAdapter } from './adapters/simpleuploadadapter';
-export type { SimpleUploadConfig } from './uploadconfig';
-import './augmentation';
+/**
+ * @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
+ */
+export { default as FileRepository, type UploadAdapter, type UploadResponse, type FileLoader } from './filerepository';
+export { default as FileDialogButtonView } from './ui/filedialogbuttonview';
+export { default as Base64UploadAdapter } from './adapters/base64uploadadapter';
+export { default as SimpleUploadAdapter } from './adapters/simpleuploadadapter';
+export type { SimpleUploadConfig } from './uploadconfig';
+import './augmentation';

package/src/index.js

@@ -1,12 +1,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 upload
- */
-export { default as FileRepository } from './filerepository';
-export { default as FileDialogButtonView } from './ui/filedialogbuttonview';
-export { default as Base64UploadAdapter } from './adapters/base64uploadadapter';
-export { default as SimpleUploadAdapter } from './adapters/simpleuploadadapter';
-import './augmentation';
+/**
+ * @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
+ */
+export { default as FileRepository } from './filerepository';
+export { default as FileDialogButtonView } from './ui/filedialogbuttonview';
+export { default as Base64UploadAdapter } from './adapters/base64uploadadapter';
+export { default as SimpleUploadAdapter } from './adapters/simpleuploadadapter';
+import './augmentation';

package/src/ui/filedialogbuttonview.d.ts

@@ -1,84 +1,83 @@
-/**
- * @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/ui/filedialogbuttonview
- */
-import { ButtonView, View } from '@ckeditor/ckeditor5-ui';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The file dialog button view.
- *
- * This component provides a button that opens the native file selection dialog.
- * It can be used to implement the UI of a file upload feature.
- *
- * ```ts
- * const view = new FileDialogButtonView( locale );
- *
- * view.set( {
- * 	acceptedType: 'image/*',
- * 	allowMultipleFiles: true
- * } );
- *
- * view.buttonView.set( {
- * 	label: t( 'Insert image' ),
- * 	icon: imageIcon,
- * 	tooltip: true
- * } );
- *
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of Array.from( files ) ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * } );
- * ```
- */
-export default class FileDialogButtonView extends View {
-    /**
-     * The button view of the component.
-     */
-    buttonView: ButtonView;
-    /**
-     * A hidden `<input>` view used to execute file dialog.
-     */
-    private _fileInputView;
-    /**
-     * Accepted file types. Can be provided in form of file extensions, media type or one of:
-     * * `audio/*`,
-     * * `video/*`,
-     * * `image/*`.
-     *
-     * @observable
-     */
-    acceptedType: string;
-    /**
-     * Indicates if multiple files can be selected. Defaults to `true`.
-     *
-     * @observable
-     */
-    allowMultipleFiles: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * Focuses the {@link #buttonView}.
-     */
-    focus(): void;
-}
-/**
- * Fired when file dialog is closed with file selected.
- *
- * ```ts
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of files ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * }
- * ```
- */
-export type FileInputViewDoneEvent = {
-    name: 'done';
-    args: [files: FileList];
-};
+/**
+ * @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/ui/filedialogbuttonview
+ */
+import { ButtonView } from '@ckeditor/ckeditor5-ui';
+import type { Locale } from '@ckeditor/ckeditor5-utils';
+/**
+ * The file dialog button view.
+ *
+ * This component provides a button that opens the native file selection dialog.
+ * It can be used to implement the UI of a file upload feature.
+ *
+ * ```ts
+ * const view = new FileDialogButtonView( locale );
+ *
+ * view.set( {
+ * 	acceptedType: 'image/*',
+ * 	allowMultipleFiles: true
+ * 	label: t( 'Insert image' ),
+ * 	icon: imageIcon,
+ * 	tooltip: true
+ * } );
+ *
+ * view.on( 'done', ( evt, files ) => {
+ * 	for ( const file of Array.from( files ) ) {
+ * 		console.log( 'Selected file', file );
+ * 	}
+ * } );
+ * ```
+ */
+export default class FileDialogButtonView extends ButtonView {
+    /**
+     * The button view of the component.
+     *
+     * @deprecated
+     */
+    buttonView: ButtonView;
+    /**
+     * A hidden `<input>` view used to execute file dialog.
+     */
+    private _fileInputView;
+    /**
+     * Accepted file types. Can be provided in form of file extensions, media type or one of:
+     * * `audio/*`,
+     * * `video/*`,
+     * * `image/*`.
+     *
+     * @observable
+     */
+    acceptedType: string;
+    /**
+     * Indicates if multiple files can be selected. Defaults to `true`.
+     *
+     * @observable
+     */
+    allowMultipleFiles: boolean;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+}
+/**
+ * Fired when file dialog is closed with file selected.
+ *
+ * ```ts
+ * view.on( 'done', ( evt, files ) => {
+ * 	for ( const file of files ) {
+ * 		console.log( 'Selected file', file );
+ * 	}
+ * }
+ * ```
+ */
+export type FileInputViewDoneEvent = {
+    name: 'done';
+    args: [files: FileList];
+};

package/src/ui/filedialogbuttonview.js

@@ -1,108 +1,102 @@
-/**
- * @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/ui/filedialogbuttonview
- */
-import { ButtonView, View } from '@ckeditor/ckeditor5-ui';
-/**
- * The file dialog button view.
- *
- * This component provides a button that opens the native file selection dialog.
- * It can be used to implement the UI of a file upload feature.
- *
- * ```ts
- * const view = new FileDialogButtonView( locale );
- *
- * view.set( {
- * 	acceptedType: 'image/*',
- * 	allowMultipleFiles: true
- * } );
- *
- * view.buttonView.set( {
- * 	label: t( 'Insert image' ),
- * 	icon: imageIcon,
- * 	tooltip: true
- * } );
- *
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of Array.from( files ) ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * } );
- * ```
- */
-export default class FileDialogButtonView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale) {
-        super(locale);
-        this.buttonView = new ButtonView(locale);
-        this._fileInputView = new FileInputView(locale);
-        this._fileInputView.bind('acceptedType').to(this);
-        this._fileInputView.bind('allowMultipleFiles').to(this);
-        this._fileInputView.delegate('done').to(this);
-        this.setTemplate({
-            tag: 'span',
-            attributes: {
-                class: 'ck-file-dialog-button'
-            },
-            children: [
-                this.buttonView,
-                this._fileInputView
-            ]
-        });
-        this.buttonView.on('execute', () => {
-            this._fileInputView.open();
-        });
-    }
-    /**
-     * Focuses the {@link #buttonView}.
-     */
-    focus() {
-        this.buttonView.focus();
-    }
-}
-/**
- * The hidden file input view class.
- */
-class FileInputView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale) {
-        super(locale);
-        this.set('acceptedType', undefined);
-        this.set('allowMultipleFiles', false);
-        const bind = this.bindTemplate;
-        this.setTemplate({
-            tag: 'input',
-            attributes: {
-                class: [
-                    'ck-hidden'
-                ],
-                type: 'file',
-                tabindex: '-1',
-                accept: bind.to('acceptedType'),
-                multiple: bind.to('allowMultipleFiles')
-            },
-            on: {
-                // Removing from code coverage since we cannot programmatically set input element files.
-                change: bind.to(/* istanbul ignore next -- @preserve */ () => {
-                    if (this.element && this.element.files && this.element.files.length) {
-                        this.fire('done', this.element.files);
-                    }
-                    this.element.value = '';
-                })
-            }
-        });
-    }
-    /**
-     * Opens file dialog.
-     */
-    open() {
-        this.element.click();
-    }
-}
+/**
+ * @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/ui/filedialogbuttonview
+ */
+import { ButtonView, View } from '@ckeditor/ckeditor5-ui';
+/**
+ * The file dialog button view.
+ *
+ * This component provides a button that opens the native file selection dialog.
+ * It can be used to implement the UI of a file upload feature.
+ *
+ * ```ts
+ * const view = new FileDialogButtonView( locale );
+ *
+ * view.set( {
+ * 	acceptedType: 'image/*',
+ * 	allowMultipleFiles: true
+ * 	label: t( 'Insert image' ),
+ * 	icon: imageIcon,
+ * 	tooltip: true
+ * } );
+ *
+ * view.on( 'done', ( evt, files ) => {
+ * 	for ( const file of Array.from( files ) ) {
+ * 		console.log( 'Selected file', file );
+ * 	}
+ * } );
+ * ```
+ */
+export default class FileDialogButtonView extends ButtonView {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale) {
+        super(locale);
+        // For backward compatibility.
+        this.buttonView = this;
+        this._fileInputView = new FileInputView(locale);
+        this._fileInputView.bind('acceptedType').to(this);
+        this._fileInputView.bind('allowMultipleFiles').to(this);
+        this._fileInputView.delegate('done').to(this);
+        this.on('execute', () => {
+            this._fileInputView.open();
+        });
+        this.extendTemplate({
+            attributes: {
+                class: 'ck-file-dialog-button'
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        this.children.add(this._fileInputView);
+    }
+}
+/**
+ * The hidden file input view class.
+ */
+class FileInputView extends View {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale) {
+        super(locale);
+        this.set('acceptedType', undefined);
+        this.set('allowMultipleFiles', false);
+        const bind = this.bindTemplate;
+        this.setTemplate({
+            tag: 'input',
+            attributes: {
+                class: [
+                    'ck-hidden'
+                ],
+                type: 'file',
+                tabindex: '-1',
+                accept: bind.to('acceptedType'),
+                multiple: bind.to('allowMultipleFiles')
+            },
+            on: {
+                // Removing from code coverage since we cannot programmatically set input element files.
+                change: bind.to(/* istanbul ignore next -- @preserve */ () => {
+                    if (this.element && this.element.files && this.element.files.length) {
+                        this.fire('done', this.element.files);
+                    }
+                    this.element.value = '';
+                })
+            }
+        });
+    }
+    /**
+     * Opens file dialog.
+     */
+    open() {
+        this.element.click();
+    }
+}

package/src/uploadconfig.d.ts

@@ -1,90 +1,90 @@
-/**
- * @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/uploadconfig
- */
-/**
- * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
- *
- * ```ts
- * 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}.
- */
-export interface SimpleUploadConfig {
-    /**
-     * 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.
-     */
-    uploadUrl: string;
-    /**
-     * 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.
-     *
-     * ```ts
-     * 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.
-     */
-    headers?: Record<string, string>;
-    /**
-     * 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.
-     *
-     * ```ts
-     * 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.
-     *
-     * @default false
-     */
-    withCredentials?: boolean;
-}
+/**
+ * @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/uploadconfig
+ */
+/**
+ * The configuration of the {@link module:upload/adapters/simpleuploadadapter~SimpleUploadAdapter simple upload adapter}.
+ *
+ * ```ts
+ * 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}.
+ */
+export interface SimpleUploadConfig {
+    /**
+     * 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.
+     */
+    uploadUrl: string;
+    /**
+     * 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.
+     *
+     * ```ts
+     * 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.
+     */
+    headers?: Record<string, string>;
+    /**
+     * 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.
+     *
+     * ```ts
+     * 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.
+     *
+     * @default false
+     */
+    withCredentials?: boolean;
+}

package/src/uploadconfig.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 {};