@ckeditor/ckeditor5-upload 36.0.1 → 37.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-upload",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.1",
   "description": "Upload feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -11,9 +11,9 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-utils": "^36.0.1",
-    "@ckeditor/ckeditor5-ui": "^36.0.1"
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.1"
   },
   "devDependencies": {
     "typescript": "^4.8.4",
@@ -42,7 +42,8 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/adapters/base64uploadadapter.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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/base64uploadadapter
+ */
+import { Plugin, type PluginDependencies } from '@ckeditor/ckeditor5-core';
+/**
+ * A plugin that converts images inserted into the editor into [Base64 strings](https://en.wikipedia.org/wiki/Base64)
+ * in the {@glink installation/getting-started/getting-and-setting-data editor output}.
+ *
+ * This kind of image upload does not require server processing – images are stored with the rest of the text and
+ * displayed by the web browser without additional requests.
+ *
+ * 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 Base64UploadAdapter extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Base64UploadAdapter';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/adapters/base64uploadadapter.js

@@ -17,8 +17,6 @@ import FileRepository from '../filerepository';
  *
  * 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.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class Base64UploadAdapter extends Plugin {
     /**
@@ -42,29 +40,18 @@ export default class Base64UploadAdapter extends Plugin {
 }
 /**
  * The upload adapter that converts images inserted into the editor into Base64 strings.
- *
- * @private
- * @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) => {
@@ -87,7 +74,6 @@ class Adapter {
      * Aborts the upload process.
      *
      * @see module:upload/filerepository~UploadAdapter#abort
-     * @returns {Promise}
      */
     abort() {
         this.reader.abort();

package/src/adapters/simpleuploadadapter.d.ts

@@ -0,0 +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 upload/adapters/simpleuploadadapter
+ */
+import { Plugin, type PluginDependencies } from '@ckeditor/ckeditor5-core';
+/**
+ * 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(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'SimpleUploadAdapter';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/adapters/simpleuploadadapter.js

@@ -12,27 +12,27 @@ 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/adapters/simpleuploadadapter~SimpleUploadConfig editor configuration}.
+ * minimal {@link module:upload/uploadconfig~SimpleUploadConfig editor configuration}.
  *
- *		ClassicEditor
- *			.create( document.querySelector( '#editor' ), {
- *				simpleUpload: {
- *					uploadUrl: 'http://example.com',
- *					headers: {
- *						...
- *					}
- *				}
- *			} )
- *			.then( ... )
- *			.catch( ... );
+ * ```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.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class SimpleUploadAdapter extends Plugin {
     /**
@@ -57,7 +57,7 @@ export default class SimpleUploadAdapter extends Plugin {
         }
         if (!options.uploadUrl) {
             /**
-             * The {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `config.simpleUpload.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.
              *
@@ -73,36 +73,19 @@ export default class SimpleUploadAdapter extends Plugin {
 }
 /**
  * Upload adapter.
- *
- * @private
- * @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
@@ -116,7 +99,6 @@ class Adapter {
      * Aborts the upload process.
      *
      * @see module:upload/filerepository~UploadAdapter#abort
-     * @returns {Promise}
      */
     abort() {
         if (this.xhr) {
@@ -125,10 +107,8 @@ class Adapter {
     }
     /**
      * Initializes the `XMLHttpRequest` object using the URL specified as
-     * {@link module:upload/adapters/simpleuploadadapter~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
+     * {@link module:upload/uploadconfig~SimpleUploadConfig#uploadUrl `simpleUpload.uploadUrl`} in the editor's
      * configuration.
-     *
-     * @private
      */
     _initRequest() {
         const xhr = this.xhr = new XMLHttpRequest();
@@ -138,10 +118,9 @@ class Adapter {
     /**
      * 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.
+     * @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;
@@ -176,8 +155,7 @@ class Adapter {
     /**
      * Prepares the data and sends the request.
      *
-     * @private
-     * @param {File} file File instance to be uploaded.
+     * @param file File instance to be uploaded.
      */
     _sendRequest(file) {
         // Set headers if specified.

package/src/augmentation.d.ts

@@ -0,0 +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;
+    }
+}

package/src/augmentation.js

@@ -0,0 +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 {};

package/src/filereader.d.ts

@@ -0,0 +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 {};

package/src/filereader.js

@@ -17,21 +17,8 @@ export default class FileReader extends ObservableMixin() {
     constructor() {
         super();
         const reader = new window.FileReader();
-        /**
-         * Instance of native FileReader.
-         *
-         * @private
-         * @member {FileReader} #_reader
-         */
         this._reader = reader;
         this._data = undefined;
-        /**
-         * Number of bytes loaded.
-         *
-         * @readonly
-         * @observable
-         * @member {Number} #loaded
-         */
         this.set('loaded', 0);
         reader.onprogress = evt => {
             this.loaded = evt.loaded;
@@ -39,8 +26,6 @@ export default class FileReader extends ObservableMixin() {
     }
     /**
      * Returns error that occurred during file reading.
-     *
-     * @returns {Error}
      */
     get error() {
         return this._reader.error;
@@ -48,8 +33,6 @@ export default class FileReader extends ObservableMixin() {
     /**
      * Holds the data of an already loaded file. The file must be first loaded
      * by using {@link module:upload/filereader~FileReader#read `read()`}.
-     *
-     * @type {File|undefined}
      */
     get data() {
         return this._data;
@@ -57,8 +40,8 @@ export default class FileReader extends ObservableMixin() {
     /**
      * Reads the provided file.
      *
-     * @param {File} file Native File object.
-     * @returns {Promise.<String>} Returns a promise that will be resolved with file's content.
+     * @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) {