@ckeditor/ckeditor5-adapter-ckfinder 35.4.0 → 36.0.1

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor 5 CKFinder adapter** – https://github.com/ckeditor/ckeditor5-adapter-ckfinder <br>
-Copyright (c) 2003-2022, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 

package/build/adapter-ckfinder.js

@@ -1,4 +1,4 @@
 /*!
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
- */(()=>{var e={704:(e,t,r)=>{e.exports=r(79)("./src/core.js")},448:(e,t,r)=>{e.exports=r(79)("./src/upload.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function r(o){var n=t[o];if(void 0!==n)return n.exports;var s=t[o]={exports:{}};return e[o](s,s.exports,r),s.exports}r.d=(e,t)=>{for(var o in t)r.o(t,o)&&!r.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},r.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{UploadAdapter:()=>d});var e=r(704),t=r(448);const n="ckCsrfToken",s="abcdefghijklmnopqrstuvwxyz0123456789";function i(){let e=function(e){e=e.toLowerCase();const t=document.cookie.split(";");for(const r of t){const t=r.split("=");if(decodeURIComponent(t[0].trim().toLowerCase())===e)return decodeURIComponent(t[1])}return null}(n);var t,r;return e&&40==e.length||(e=function(e){let t="";const r=new Uint8Array(e);window.crypto.getRandomValues(r);for(let e=0;e<r.length;e++){const o=s.charAt(r[e]%s.length);t+=Math.random()>.5?o.toUpperCase():o}return t}(40),t=n,r=e,document.cookie=encodeURIComponent(t)+"="+encodeURIComponent(r)+";path=/"),e}class d extends e.Plugin{static get requires(){return[t.FileRepository]}static get pluginName(){return"CKFinderUploadAdapter"}init(){const e=this.editor.config.get("ckfinder.uploadUrl");e&&(this.editor.plugins.get(t.FileRepository).createUploadAdapter=t=>new a(t,e,this.editor.t))}}class a{constructor(e,t,r){this.loader=e,this.url=t,this.t=r}upload(){return this.loader.file.then((e=>new Promise(((t,r)=>{this._initRequest(),this._initListeners(t,r,e),this._sendRequest(e)}))))}abort(){this.xhr&&this.xhr.abort()}_initRequest(){const e=this.xhr=new XMLHttpRequest;e.open("POST",this.url,!0),e.responseType="json"}_initListeners(e,t,r){const o=this.xhr,n=this.loader,s=(0,this.t)("Cannot upload file:")+` ${r.name}.`;o.addEventListener("error",(()=>t(s))),o.addEventListener("abort",(()=>t())),o.addEventListener("load",(()=>{const r=o.response;if(!r||!r.uploaded)return t(r&&r.error&&r.error.message?r.error.message:s);e({default:r.url})})),o.upload&&o.upload.addEventListener("progress",(e=>{e.lengthComputable&&(n.uploadTotal=e.total,n.uploaded=e.loaded)}))}_sendRequest(e){const t=new FormData;t.append("upload",e),t.append("ckCsrfToken",i()),this.xhr.send(t)}}})(),(window.CKEditor5=window.CKEditor5||{}).adapterCkfinder=o})();
+ */(()=>{var e={704:(e,t,r)=>{e.exports=r(79)("./src/core.js")},448:(e,t,r)=>{e.exports=r(79)("./src/upload.js")},79:e=>{"use strict";e.exports=CKEditor5.dll}},t={};function r(o){var n=t[o];if(void 0!==n)return n.exports;var s=t[o]={exports:{}};return e[o](s,s.exports,r),s.exports}r.d=(e,t)=>{for(var o in t)r.o(t,o)&&!r.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},r.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{UploadAdapter:()=>a});var e=r(704),t=r(448);const n="ckCsrfToken",s=40,i="abcdefghijklmnopqrstuvwxyz0123456789";function d(){let e=function(e){e=e.toLowerCase();const t=document.cookie.split(";");for(const r of t){const t=r.split("=");if(decodeURIComponent(t[0].trim().toLowerCase())===e)return decodeURIComponent(t[1])}return null}(n);var t,r;return e&&e.length==s||(e=function(e){let t="";const r=new Uint8Array(e);window.crypto.getRandomValues(r);for(let e=0;e<r.length;e++){const o=i.charAt(r[e]%i.length);t+=Math.random()>.5?o.toUpperCase():o}return t}(s),t=n,r=e,document.cookie=encodeURIComponent(t)+"="+encodeURIComponent(r)+";path=/"),e}class a extends e.Plugin{static get requires(){return[t.FileRepository]}static get pluginName(){return"CKFinderUploadAdapter"}init(){const e=this.editor.config.get("ckfinder.uploadUrl");e&&(this.editor.plugins.get(t.FileRepository).createUploadAdapter=t=>new l(t,e,this.editor.t))}}class l{constructor(e,t,r){this.loader=e,this.url=t,this.t=r}upload(){return this.loader.file.then((e=>new Promise(((t,r)=>{this._initRequest(),this._initListeners(t,r,e),this._sendRequest(e)}))))}abort(){this.xhr&&this.xhr.abort()}_initRequest(){const e=this.xhr=new XMLHttpRequest;e.open("POST",this.url,!0),e.responseType="json"}_initListeners(e,t,r){const o=this.xhr,n=this.loader,s=(0,this.t)("Cannot upload file:")+` ${r.name}.`;o.addEventListener("error",(()=>t(s))),o.addEventListener("abort",(()=>t())),o.addEventListener("load",(()=>{const r=o.response;if(!r||!r.uploaded)return t(r&&r.error&&r.error.message?r.error.message:s);e({default:r.url})})),o.upload&&o.upload.addEventListener("progress",(e=>{e.lengthComputable&&(n.uploadTotal=e.total,n.uploaded=e.loaded)}))}_sendRequest(e){const t=new FormData;t.append("upload",e),t.append("ckCsrfToken",d()),this.xhr.send(t)}}})(),(window.CKEditor5=window.CKEditor5||{}).adapterCkfinder=o})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-adapter-ckfinder",
-  "version": "35.4.0",
+  "version": "36.0.1",
   "description": "CKFinder adapter for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,23 +12,24 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^35.4.0"
+    "ckeditor5": "^36.0.1"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^35.4.0",
-    "@ckeditor/ckeditor5-core": "^35.4.0",
-    "@ckeditor/ckeditor5-clipboard": "^35.4.0",
-    "@ckeditor/ckeditor5-dev-utils": "^31.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^35.4.0",
-    "@ckeditor/ckeditor5-enter": "^35.4.0",
-    "@ckeditor/ckeditor5-heading": "^35.4.0",
-    "@ckeditor/ckeditor5-image": "^35.4.0",
-    "@ckeditor/ckeditor5-list": "^35.4.0",
-    "@ckeditor/ckeditor5-paragraph": "^35.4.0",
-    "@ckeditor/ckeditor5-theme-lark": "^35.4.0",
-    "@ckeditor/ckeditor5-typing": "^35.4.0",
-    "@ckeditor/ckeditor5-undo": "^35.4.0",
-    "@ckeditor/ckeditor5-upload": "^35.4.0",
+    "@ckeditor/ckeditor5-basic-styles": "^36.0.1",
+    "@ckeditor/ckeditor5-core": "^36.0.1",
+    "@ckeditor/ckeditor5-clipboard": "^36.0.1",
+    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
+    "@ckeditor/ckeditor5-enter": "^36.0.1",
+    "@ckeditor/ckeditor5-heading": "^36.0.1",
+    "@ckeditor/ckeditor5-image": "^36.0.1",
+    "@ckeditor/ckeditor5-list": "^36.0.1",
+    "@ckeditor/ckeditor5-paragraph": "^36.0.1",
+    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
+    "@ckeditor/ckeditor5-typing": "^36.0.1",
+    "@ckeditor/ckeditor5-undo": "^36.0.1",
+    "@ckeditor/ckeditor5-upload": "^36.0.1",
+    "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
   },
@@ -47,13 +48,16 @@
   },
   "files": [
     "lang",
-    "src",
+    "src/**/*.js",
+    "src/**/*.d.ts",
     "theme",
     "build",
     "ckeditor5-metadata.json",
     "CHANGELOG.md"
   ],
   "scripts": {
-    "dll:build": "webpack"
+    "dll:build": "webpack",
+    "build": "tsc -p ./tsconfig.release.json",
+    "postversion": "npm run build"
   }
 }

package/src/index.js

@@ -1,10 +1,8 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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 adapter-ckfinder
  */
-
 export { default as UploadAdapter } from './uploadadapter';

package/src/uploadadapter.js

@@ -1,19 +1,14 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
-
 /* globals XMLHttpRequest, FormData */
-
 /**
  * @module adapter-ckfinder/uploadadapter
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import { FileRepository } from 'ckeditor5/src/upload';
-
 import { getCsrfToken } from './utils';
-
 /**
  * A plugin that enables file uploads in CKEditor 5 using the CKFinder server–side connector.
  *
@@ -23,168 +18,121 @@ import { getCsrfToken } from './utils';
  *
  * 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 CKFinderUploadAdapter extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ FileRepository ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'CKFinderUploadAdapter';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const url = this.editor.config.get( 'ckfinder.uploadUrl' );
-
-		if ( !url ) {
-			return;
-		}
-
-		// Register CKFinderAdapter
-		this.editor.plugins.get( FileRepository ).createUploadAdapter = loader => new UploadAdapter( loader, url, this.editor.t );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FileRepository];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CKFinderUploadAdapter';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const url = this.editor.config.get('ckfinder.uploadUrl');
+        if (!url) {
+            return;
+        }
+        // Register CKFinderAdapter
+        this.editor.plugins.get(FileRepository).createUploadAdapter = loader => new UploadAdapter(loader, url, this.editor.t);
+    }
 }
-
 /**
  * Upload adapter for CKFinder.
- *
- * @private
- * @implements module:upload/filerepository~UploadAdapter
  */
 class UploadAdapter {
-	/**
-	 * Creates a new adapter instance.
-	 *
-	 * @param {module:upload/filerepository~FileLoader} loader
-	 * @param {String} url
-	 * @param {module:utils/locale~Locale#t} t
-	 */
-	constructor( loader, url, t ) {
-		/**
-		 * FileLoader instance to use during the upload.
-		 *
-		 * @member {module:upload/filerepository~FileLoader} #loader
-		 */
-		this.loader = loader;
-
-		/**
-		 * Upload URL.
-		 *
-		 * @member {String} #url
-		 */
-		this.url = url;
-
-		/**
-		 * Locale translation method.
-		 *
-		 * @member {module:utils/locale~Locale#t} #t
-		 */
-		this.t = t;
-	}
-
-	/**
-	 * Starts the upload process.
-	 *
-	 * @see module:upload/filerepository~UploadAdapter#upload
-	 * @returns {Promise.<Object>}
-	 */
-	upload() {
-		return this.loader.file.then( file => {
-			return 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.
-	 *
-	 * @private
-	 */
-	_initRequest() {
-		const xhr = this.xhr = new XMLHttpRequest();
-
-		xhr.open( 'POST', this.url, true );
-		xhr.responseType = 'json';
-	}
-
-	/**
-	 * 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 File instance to be uploaded.
-	 */
-	_initListeners( resolve, reject, file ) {
-		const xhr = this.xhr;
-		const loader = this.loader;
-		const t = this.t;
-		const genericError = t( 'Cannot upload file:' ) + ` ${ file.name }.`;
-
-		xhr.addEventListener( 'error', () => reject( genericError ) );
-		xhr.addEventListener( 'abort', () => reject() );
-		xhr.addEventListener( 'load', () => {
-			const response = xhr.response;
-
-			if ( !response || !response.uploaded ) {
-				return reject( response && response.error && response.error.message ? response.error.message : genericError );
-			}
-
-			resolve( {
-				default: response.url
-			} );
-		} );
-
-		// Upload progress when it's supported.
-		/* istanbul ignore else */
-		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.
-	 *
-	 * @private
-	 * @param {File} file File instance to be uploaded.
-	 */
-	_sendRequest( file ) {
-		// Prepare form data.
-		const data = new FormData();
-		data.append( 'upload', file );
-		data.append( 'ckCsrfToken', getCsrfToken() );
-
-		// Send request.
-		this.xhr.send( data );
-	}
+    /**
+     * Creates a new adapter instance.
+     */
+    constructor(loader, url, t) {
+        this.loader = loader;
+        this.url = url;
+        this.t = t;
+    }
+    /**
+     * Starts the upload process.
+     *
+     * @see module:upload/filerepository~UploadAdapter#upload
+     */
+    upload() {
+        return this.loader.file.then(file => {
+            return 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.
+     */
+    _initRequest() {
+        const xhr = this.xhr = new XMLHttpRequest();
+        xhr.open('POST', this.url, 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 File instance to be uploaded.
+     */
+    _initListeners(resolve, reject, file) {
+        const xhr = this.xhr;
+        const loader = this.loader;
+        const t = this.t;
+        const genericError = t('Cannot upload file:') + ` ${file.name}.`;
+        xhr.addEventListener('error', () => reject(genericError));
+        xhr.addEventListener('abort', () => reject());
+        xhr.addEventListener('load', () => {
+            const response = xhr.response;
+            if (!response || !response.uploaded) {
+                return reject(response && response.error && response.error.message ? response.error.message : genericError);
+            }
+            resolve({
+                default: response.url
+            });
+        });
+        // Upload progress when it's supported.
+        /* istanbul ignore else */
+        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) {
+        // Prepare form data.
+        const data = new FormData();
+        data.append('upload', file);
+        data.append('ckCsrfToken', getCsrfToken());
+        // Send request.
+        this.xhr.send(data);
+    }
 }

package/src/utils.js

@@ -1,83 +1,58 @@
 /**
- * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
+ * @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
  */
-
 /* globals window, document */
-
 /**
  * @module adapter-ckfinder/utils
  */
-
 const TOKEN_COOKIE_NAME = 'ckCsrfToken';
 const TOKEN_LENGTH = 40;
 const tokenCharset = 'abcdefghijklmnopqrstuvwxyz0123456789';
-
 /**
  * Returns the CSRF token value. The value is a hash stored in `document.cookie`
  * under the `ckCsrfToken` key. The CSRF token can be used to secure the communication
  * between the web browser and the CKFinder server.
- *
- * @returns {String}
  */
 export function getCsrfToken() {
-	let token = getCookie( TOKEN_COOKIE_NAME );
-
-	if ( !token || token.length != TOKEN_LENGTH ) {
-		token = generateToken( TOKEN_LENGTH );
-		setCookie( TOKEN_COOKIE_NAME, token );
-	}
-
-	return token;
+    let token = getCookie(TOKEN_COOKIE_NAME);
+    if (!token || token.length != TOKEN_LENGTH) {
+        token = generateToken(TOKEN_LENGTH);
+        setCookie(TOKEN_COOKIE_NAME, token);
+    }
+    return token;
 }
-
 /**
  * Returns the value of the cookie with a given name or `null` if the cookie is not found.
- *
- * @param {String} name
- * @returns {String|null}
  */
-export function getCookie( name ) {
-	name = name.toLowerCase();
-	const parts = document.cookie.split( ';' );
-
-	for ( const part of parts ) {
-		const pair = part.split( '=' );
-		const key = decodeURIComponent( pair[ 0 ].trim().toLowerCase() );
-
-		if ( key === name ) {
-			return decodeURIComponent( pair[ 1 ] );
-		}
-	}
-
-	return null;
+export function getCookie(name) {
+    name = name.toLowerCase();
+    const parts = document.cookie.split(';');
+    for (const part of parts) {
+        const pair = part.split('=');
+        const key = decodeURIComponent(pair[0].trim().toLowerCase());
+        if (key === name) {
+            return decodeURIComponent(pair[1]);
+        }
+    }
+    return null;
 }
-
 /**
  * Sets the value of the cookie with a given name.
- *
- * @param {String} name
- * @param {String} value
  */
-export function setCookie( name, value ) {
-	document.cookie = encodeURIComponent( name ) + '=' + encodeURIComponent( value ) + ';path=/';
+export function setCookie(name, value) {
+    document.cookie = encodeURIComponent(name) + '=' + encodeURIComponent(value) + ';path=/';
 }
-
-// Generates the CSRF token with the given length.
-//
-// @private
-// @param {Number} length
-// @returns {string}
-function generateToken( length ) {
-	let result = '';
-	const randValues = new Uint8Array( length );
-
-	window.crypto.getRandomValues( randValues );
-
-	for ( let j = 0; j < randValues.length; j++ ) {
-		const character = tokenCharset.charAt( randValues[ j ] % tokenCharset.length );
-		result += Math.random() > 0.5 ? character.toUpperCase() : character;
-	}
-
-	return result;
+/**
+ * Generates the CSRF token with the given length.
+ */
+function generateToken(length) {
+    let result = '';
+    const randValues = new Uint8Array(length);
+    window.crypto.getRandomValues(randValues);
+    for (let j = 0; j < randValues.length; j++) {
+        const character = tokenCharset.charAt(randValues[j] % tokenCharset.length);
+        result += Math.random() > 0.5 ? character.toUpperCase() : character;
+    }
+    return result;
 }