@ckeditor/ckeditor5-upload 0.0.0-nightly-20240423.0 → 0.0.0-nightly-20240425.0

package/dist/types/uploadconfig.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-upload",
-  "version": "0.0.0-nightly-20240423.0",
+  "version": "0.0.0-nightly-20240425.0",
   "description": "Upload feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,8 +12,8 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20240423.0",
-    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20240423.0"
+    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20240425.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20240425.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -25,6 +25,7 @@
     "directory": "packages/ckeditor5-upload"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",