@ckeditor/ckeditor5-cloud-services 36.0.1 → 37.0.0-alpha.0

package/src/cloudservicescore.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @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/cloudservicescore
+ */
+import { ContextPlugin } from 'ckeditor5/src/core';
+import type { TokenUrl } from './cloudservicesconfig';
+import Token, { type InitializedToken, type TokenOptions } from './token/token';
+import UploadGateway from './uploadgateway/uploadgateway';
+/**
+ * The `CloudServicesCore` plugin exposes the base API for communication with CKEditor Cloud Services.
+ */
+export default class CloudServicesCore extends ContextPlugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'CloudServicesCore';
+    /**
+     * Creates the {@link module:cloud-services/token~Token} instance.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     * @param options.initValue Initial value of the token.
+     * @param options.autoRefresh Specifies whether to start the refresh automatically.
+     */
+    createToken(tokenUrlOrRefreshToken: TokenUrl, options?: TokenOptions): Token;
+    /**
+     * Creates the {@link module:cloud-services/uploadgateway/uploadgateway~UploadGateway} instance.
+     *
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    createUploadGateway(token: InitializedToken, apiAddress: string): UploadGateway;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [CloudServicesCore.pluginName]: CloudServicesCore;
+    }
+}

package/src/cloudservicescore.js

@@ -2,50 +2,40 @@
  * @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/cloudservicescore
  */
-
 import { ContextPlugin } from 'ckeditor5/src/core';
 import Token from './token/token';
 import UploadGateway from './uploadgateway/uploadgateway';
-
 /**
  * The `CloudServicesCore` plugin exposes the base API for communication with CKEditor Cloud Services.
- *
- * @extends module:core/contextplugin~ContextPlugin
  */
 export default class CloudServicesCore extends ContextPlugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'CloudServicesCore';
-	}
-
-	/**
-	 * Creates the {@link module:cloud-services/token~Token} instance.
-	 *
-	 * @param {String|Function} tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
-	 * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
-	 * @param {Object} [options]
-	 * @param {String} [options.initValue] Initial value of the token.
-	 * @param {Boolean} [options.autoRefresh=true] Specifies whether to start the refresh automatically.
-	 * @returns {module:cloud-services/token~Token}
-	 */
-	createToken( tokenUrlOrRefreshToken, options ) {
-		return new Token( tokenUrlOrRefreshToken, options );
-	}
-
-	/**
-	 * Creates the {@link module:cloud-services/uploadgateway/uploadgateway~UploadGateway} instance.
-	 *
-	 * @param {module:cloud-services/token~Token} token Token used for authentication.
-	 * @param {String} apiAddress API address.
-	 * @returns {module:cloud-services/uploadgateway/uploadgateway~UploadGateway}
-	 */
-	createUploadGateway( token, apiAddress ) {
-		return new UploadGateway( token, apiAddress );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CloudServicesCore';
+    }
+    /**
+     * Creates the {@link module:cloud-services/token~Token} instance.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     * @param options.initValue Initial value of the token.
+     * @param options.autoRefresh Specifies whether to start the refresh automatically.
+     */
+    createToken(tokenUrlOrRefreshToken, options) {
+        return new Token(tokenUrlOrRefreshToken, options);
+    }
+    /**
+     * Creates the {@link module:cloud-services/uploadgateway/uploadgateway~UploadGateway} instance.
+     *
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    createUploadGateway(token, apiAddress) {
+        return new UploadGateway(token, apiAddress);
+    }
 }

package/src/index.d.ts

@@ -0,0 +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 cloud-services
+ */
+export { default as CloudServices } from './cloudservices';
+export { default as CloudServicesCore } from './cloudservicescore';
+export { TokenUrl } from './cloudservicesconfig';
+export type { default as Token, InitializedToken } from './token/token';
+export type { default as UploadGateway } from './uploadgateway/uploadgateway';
+export type { default as FileUploader } from './uploadgateway/fileuploader';

package/src/index.js

@@ -2,10 +2,8 @@
  * @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
  */
-
 export { default as CloudServices } from './cloudservices';
 export { default as CloudServicesCore } from './cloudservicescore';

package/src/token/token.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @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 { TokenUrl } from '../cloudservicesconfig';
+declare const Token_base: {
+    new (): import("ckeditor5/src/utils").Observable;
+    prototype: import("ckeditor5/src/utils").Observable;
+};
+/**
+ * Class representing the token used for communication with CKEditor Cloud Services.
+ * Value of the token is retrieving from the specified URL and is refreshed every 1 hour by default.
+ */
+export default class Token extends Token_base {
+    /**
+     * Value of the token.
+     * The value of the token is undefined if `initValue` is not provided or `init` method was not called.
+     * `create` method creates token with initialized value from url.
+     *
+     * @see module:cloud-services/token~InitializedToken
+     * @observable
+     * @readonly
+     */
+    value: string | undefined;
+    /**
+     * Base refreshing function.
+     */
+    private _refresh;
+    private _options;
+    private _tokenRefreshTimeout?;
+    /**
+     * Creates `Token` instance.
+     * Method `init` should be called after using the constructor or use `create` method instead.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     */
+    constructor(tokenUrlOrRefreshToken: TokenUrl, options?: TokenOptions);
+    /**
+     * Initializes the token.
+     */
+    init(): Promise<InitializedToken>;
+    /**
+     * Refresh token method. Useful in a method form as it can be override in tests.
+     */
+    refreshToken(): Promise<InitializedToken>;
+    /**
+     * Destroys token instance. Stops refreshing.
+     */
+    destroy(): void;
+    /**
+     * Checks whether the provided token follows the JSON Web Tokens (JWT) format.
+     *
+     * @param tokenValue The token to validate.
+     */
+    private _validateTokenValue;
+    /**
+     * Registers a refresh token timeout for the time taken from token.
+     */
+    private _registerRefreshTokenTimeout;
+    /**
+     * Returns token refresh timeout time calculated from expire time in the token payload.
+     *
+     * If the token parse fails or the token payload doesn't contain, the default DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME is returned.
+     */
+    private _getTokenRefreshTimeoutTime;
+    /**
+     * Creates a initialized {@link module:cloud-services/token~Token} instance.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     */
+    static create(tokenUrlOrRefreshToken: TokenUrl, options?: TokenOptions): Promise<InitializedToken>;
+}
+/**
+ * A {@link ~Token} instance that has been initialized.
+ */
+export type InitializedToken = Token & {
+    value: string;
+};
+/**
+ * Options for creating tokens.
+ */
+export interface TokenOptions {
+    /**
+     * Initial value of the token.
+     */
+    initValue?: string;
+    /**
+     * Specifies whether to start the refresh automatically.
+     *
+     * @default true
+     */
+    autoRefresh?: boolean;
+}
+export {};

package/src/token/token.js

@@ -2,258 +2,170 @@
  * @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/token
  */
-
 /* globals XMLHttpRequest, setTimeout, clearTimeout, atob */
-
-import { mix, ObservableMixin, CKEditorError } from 'ckeditor5/src/utils';
-
+import { ObservableMixin, CKEditorError } from 'ckeditor5/src/utils';
 const DEFAULT_OPTIONS = { autoRefresh: true };
 const DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME = 3600000;
-
 /**
  * Class representing the token used for communication with CKEditor Cloud Services.
  * Value of the token is retrieving from the specified URL and is refreshed every 1 hour by default.
- *
- * @mixes ObservableMixin
  */
-class Token {
-	/**
-	 * Creates `Token` instance.
-	 * Method `init` should be called after using the constructor or use `create` method instead.
-	 *
-	 * @param {String|Function} tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
-	 * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
-	 * @param {Object} options
-	 * @param {String} [options.initValue] Initial value of the token.
-	 * @param {Boolean} [options.autoRefresh=true] Specifies whether to start the refresh automatically.
-	 */
-	constructor( tokenUrlOrRefreshToken, options = DEFAULT_OPTIONS ) {
-		if ( !tokenUrlOrRefreshToken ) {
-			/**
-			 * A `tokenUrl` must be provided as the first constructor argument.
-			 *
-			 * @error token-missing-token-url
-			 */
-			throw new CKEditorError(
-				'token-missing-token-url',
-				this
-			);
-		}
-
-		if ( options.initValue ) {
-			this._validateTokenValue( options.initValue );
-		}
-
-		/**
-		 * Value of the token.
-		 * The value of the token is null if `initValue` is not provided or `init` method was not called.
-		 * `create` method creates token with initialized value from url.
-		 *
-		 * @name value
-		 * @member {String} #value
-		 * @observable
-		 * @readonly
-		 */
-		this.set( 'value', options.initValue );
-
-		/**
-		 * Base refreshing function.
-		 *
-		 * @private
-		 * @member {String|Function} #_refresh
-		 */
-		if ( typeof tokenUrlOrRefreshToken === 'function' ) {
-			this._refresh = tokenUrlOrRefreshToken;
-		} else {
-			this._refresh = () => defaultRefreshToken( tokenUrlOrRefreshToken );
-		}
-
-		/**
-		 * @type {Object}
-		 * @private
-		 */
-		this._options = Object.assign( {}, DEFAULT_OPTIONS, options );
-	}
-
-	/**
-	 * Initializes the token.
-	 *
-	 * @returns {Promise.<module:cloud-services/token~Token>}
-	 */
-	init() {
-		return new Promise( ( resolve, reject ) => {
-			if ( !this.value ) {
-				this.refreshToken()
-					.then( resolve )
-					.catch( reject );
-
-				return;
-			}
-
-			if ( this._options.autoRefresh ) {
-				this._registerRefreshTokenTimeout();
-			}
-
-			resolve( this );
-		} );
-	}
-
-	/**
-	 * Refresh token method. Useful in a method form as it can be override in tests.
-	 * @returns {Promise.<String>}
-	 */
-	refreshToken() {
-		return this._refresh()
-			.then( value => {
-				this._validateTokenValue( value );
-				this.set( 'value', value );
-
-				if ( this._options.autoRefresh ) {
-					this._registerRefreshTokenTimeout();
-				}
-			} )
-			.then( () => this );
-	}
-
-	/**
-	 * Destroys token instance. Stops refreshing.
-	 */
-	destroy() {
-		clearTimeout( this._tokenRefreshTimeout );
-	}
-
-	/**
-	 * Checks whether the provided token follows the JSON Web Tokens (JWT) format.
-	 *
-	 * @protected
-	 * @param {String} tokenValue The token to validate.
-	 */
-	_validateTokenValue( tokenValue ) {
-		// The token must be a string.
-		const isString = typeof tokenValue === 'string';
-
-		// The token must be a plain string without quotes ("").
-		const isPlainString = !/^".*"$/.test( tokenValue );
-
-		// JWT token contains 3 parts: header, payload, and signature.
-		// Each part is separated by a dot.
-		const isJWTFormat = isString && tokenValue.split( '.' ).length === 3;
-
-		if ( !( isPlainString && isJWTFormat ) ) {
-			/**
-			 * The provided token must follow the [JSON Web Tokens](https://jwt.io/introduction/) format.
-			 *
-			 * @error token-not-in-jwt-format
-			 */
-			throw new CKEditorError( 'token-not-in-jwt-format', this );
-		}
-	}
-
-	/**
-	 * Registers a refresh token timeout for the time taken from token.
-	 *
-	 * @protected
-	 */
-	_registerRefreshTokenTimeout() {
-		const tokenRefreshTimeoutTime = this._getTokenRefreshTimeoutTime();
-
-		clearTimeout( this._tokenRefreshTimeout );
-
-		this._tokenRefreshTimeout = setTimeout( () => {
-			this.refreshToken();
-		}, tokenRefreshTimeoutTime );
-	}
-
-	/**
-	 * Returns token refresh timeout time calculated from expire time in the token payload.
-	 *
-	 * If the token parse fails or the token payload doesn't contain, the default DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME is returned.
-	 *
-	 * @protected
-	 * @returns {Number}
-	 */
-	_getTokenRefreshTimeoutTime() {
-		try {
-			const [ , binaryTokenPayload ] = this.value.split( '.' );
-			const { exp: tokenExpireTime } = JSON.parse( atob( binaryTokenPayload ) );
-
-			if ( !tokenExpireTime ) {
-				return DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME;
-			}
-
-			const tokenRefreshTimeoutTime = Math.floor( ( ( tokenExpireTime * 1000 ) - Date.now() ) / 2 );
-
-			return tokenRefreshTimeoutTime;
-		} catch ( err ) {
-			return DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME;
-		}
-	}
-
-	/**
-	 * Creates a initialized {@link module:cloud-services/token~Token} instance.
-	 *
-	 * @param {String|Function} tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
-	 * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
-	 * @param {Object} options
-	 * @param {String} [options.initValue] Initial value of the token.
-	 * @param {Boolean} [options.autoRefresh=true] Specifies whether to start the refresh automatically.
-	 * @returns {Promise.<module:cloud-services/token~Token>}
-	 */
-	static create( tokenUrlOrRefreshToken, options = DEFAULT_OPTIONS ) {
-		const token = new Token( tokenUrlOrRefreshToken, options );
-
-		return token.init();
-	}
+export default class Token extends ObservableMixin() {
+    /**
+     * Creates `Token` instance.
+     * Method `init` should be called after using the constructor or use `create` method instead.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     */
+    constructor(tokenUrlOrRefreshToken, options = {}) {
+        super();
+        if (!tokenUrlOrRefreshToken) {
+            /**
+             * A `tokenUrl` must be provided as the first constructor argument.
+             *
+             * @error token-missing-token-url
+             */
+            throw new CKEditorError('token-missing-token-url', this);
+        }
+        if (options.initValue) {
+            this._validateTokenValue(options.initValue);
+        }
+        this.set('value', options.initValue);
+        if (typeof tokenUrlOrRefreshToken === 'function') {
+            this._refresh = tokenUrlOrRefreshToken;
+        }
+        else {
+            this._refresh = () => defaultRefreshToken(tokenUrlOrRefreshToken);
+        }
+        this._options = { ...DEFAULT_OPTIONS, ...options };
+    }
+    /**
+     * Initializes the token.
+     */
+    init() {
+        return new Promise((resolve, reject) => {
+            if (!this.value) {
+                this.refreshToken()
+                    .then(resolve)
+                    .catch(reject);
+                return;
+            }
+            if (this._options.autoRefresh) {
+                this._registerRefreshTokenTimeout();
+            }
+            resolve(this);
+        });
+    }
+    /**
+     * Refresh token method. Useful in a method form as it can be override in tests.
+     */
+    refreshToken() {
+        return this._refresh()
+            .then(value => {
+            this._validateTokenValue(value);
+            this.set('value', value);
+            if (this._options.autoRefresh) {
+                this._registerRefreshTokenTimeout();
+            }
+            return this;
+        });
+    }
+    /**
+     * Destroys token instance. Stops refreshing.
+     */
+    destroy() {
+        clearTimeout(this._tokenRefreshTimeout);
+    }
+    /**
+     * Checks whether the provided token follows the JSON Web Tokens (JWT) format.
+     *
+     * @param tokenValue The token to validate.
+     */
+    _validateTokenValue(tokenValue) {
+        // The token must be a string.
+        const isString = typeof tokenValue === 'string';
+        // The token must be a plain string without quotes ("").
+        const isPlainString = !/^".*"$/.test(tokenValue);
+        // JWT token contains 3 parts: header, payload, and signature.
+        // Each part is separated by a dot.
+        const isJWTFormat = isString && tokenValue.split('.').length === 3;
+        if (!(isPlainString && isJWTFormat)) {
+            /**
+             * The provided token must follow the [JSON Web Tokens](https://jwt.io/introduction/) format.
+             *
+             * @error token-not-in-jwt-format
+             */
+            throw new CKEditorError('token-not-in-jwt-format', this);
+        }
+    }
+    /**
+     * Registers a refresh token timeout for the time taken from token.
+     */
+    _registerRefreshTokenTimeout() {
+        const tokenRefreshTimeoutTime = this._getTokenRefreshTimeoutTime();
+        clearTimeout(this._tokenRefreshTimeout);
+        this._tokenRefreshTimeout = setTimeout(() => {
+            this.refreshToken();
+        }, tokenRefreshTimeoutTime);
+    }
+    /**
+     * Returns token refresh timeout time calculated from expire time in the token payload.
+     *
+     * If the token parse fails or the token payload doesn't contain, the default DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME is returned.
+     */
+    _getTokenRefreshTimeoutTime() {
+        try {
+            const [, binaryTokenPayload] = this.value.split('.');
+            const { exp: tokenExpireTime } = JSON.parse(atob(binaryTokenPayload));
+            if (!tokenExpireTime) {
+                return DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME;
+            }
+            const tokenRefreshTimeoutTime = Math.floor(((tokenExpireTime * 1000) - Date.now()) / 2);
+            return tokenRefreshTimeoutTime;
+        }
+        catch (err) {
+            return DEFAULT_TOKEN_REFRESH_TIMEOUT_TIME;
+        }
+    }
+    /**
+     * Creates a initialized {@link module:cloud-services/token~Token} instance.
+     *
+     * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
+     * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
+     */
+    static create(tokenUrlOrRefreshToken, options = {}) {
+        const token = new Token(tokenUrlOrRefreshToken, options);
+        return token.init();
+    }
 }
-
-mix( Token, ObservableMixin );
-
 /**
  * This function is called in a defined interval by the {@link ~Token} class. It also can be invoked manually.
  * It should return a promise, which resolves with the new token value.
  * If any error occurs it should return a rejected promise with an error message.
- *
- * @function refreshToken
- * @returns {Promise.<String>}
  */
-
-/**
- * @private
- * @param {String} tokenUrl
- */
-function defaultRefreshToken( tokenUrl ) {
-	return new Promise( ( resolve, reject ) => {
-		const xhr = new XMLHttpRequest();
-
-		xhr.open( 'GET', tokenUrl );
-
-		xhr.addEventListener( 'load', () => {
-			const statusCode = xhr.status;
-			const xhrResponse = xhr.response;
-
-			if ( statusCode < 200 || statusCode > 299 ) {
-				/**
-				 * Cannot download new token from the provided url.
-				 *
-				 * @error token-cannot-download-new-token
-				 */
-				return reject(
-					new CKEditorError( 'token-cannot-download-new-token', null )
-				);
-			}
-
-			return resolve( xhrResponse );
-		} );
-
-		xhr.addEventListener( 'error', () => reject( new Error( 'Network Error' ) ) );
-		xhr.addEventListener( 'abort', () => reject( new Error( 'Abort' ) ) );
-
-		xhr.send();
-	} );
+function defaultRefreshToken(tokenUrl) {
+    return new Promise((resolve, reject) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open('GET', tokenUrl);
+        xhr.addEventListener('load', () => {
+            const statusCode = xhr.status;
+            const xhrResponse = xhr.response;
+            if (statusCode < 200 || statusCode > 299) {
+                /**
+                 * Cannot download new token from the provided url.
+                 *
+                 * @error token-cannot-download-new-token
+                 */
+                return reject(new CKEditorError('token-cannot-download-new-token', null));
+            }
+            return resolve(xhrResponse);
+        });
+        xhr.addEventListener('error', () => reject(new Error('Network Error')));
+        xhr.addEventListener('abort', () => reject(new Error('Abort')));
+        xhr.send();
+    });
 }
-
-export default Token;