@ckeditor/ckeditor5-cloud-services 40.0.0 → 40.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 Cloud Services integration** – https://github.com/ckeditor/ckeditor5-cloud-services <br>
-Copyright (c) 2003-2023, [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).
 
@@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-cloud-services",
-  "version": "40.0.0",
+  "version": "40.1.0",
   "description": "CKEditor 5's Cloud Services integration layer.",
   "keywords": [
     "ckeditor",
@@ -11,7 +11,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0"
+    "ckeditor5": "40.1.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/augmentation.d.ts

@@ -1,19 +1,19 @@
-/**
- * @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 { CloudServices, CloudServicesConfig, CloudServicesCore } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of CKEditor Cloud Services. Introduced by the {@link module:cloud-services/cloudservices~CloudServices} plugin.
-         *
-         * Read more in {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig}.
-         */
-        cloudServices?: CloudServicesConfig;
-    }
-    interface PluginsMap {
-        [CloudServices.pluginName]: CloudServices;
-        [CloudServicesCore.pluginName]: CloudServicesCore;
-    }
-}
+/**
+ * @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 { CloudServices, CloudServicesConfig, CloudServicesCore } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of CKEditor Cloud Services. Introduced by the {@link module:cloud-services/cloudservices~CloudServices} plugin.
+         *
+         * Read more in {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig}.
+         */
+        cloudServices?: CloudServicesConfig;
+    }
+    interface PluginsMap {
+        [CloudServices.pluginName]: CloudServices;
+        [CloudServicesCore.pluginName]: CloudServicesCore;
+    }
+}

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

package/src/cloudservices.d.ts

@@ -1,84 +1,84 @@
-/**
- * @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/cloudservices
- */
-import { ContextPlugin } from 'ckeditor5/src/core';
-import CloudServicesCore from './cloudservicescore';
-import type { CloudServicesConfig, TokenUrl } from './cloudservicesconfig';
-import type { InitializedToken } from './token/token';
-/**
- * Plugin introducing the integration between CKEditor 5 and CKEditor Cloud Services .
- *
- * It initializes the token provider based on
- * the {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig `config.cloudService`}.
- */
-export default class CloudServices extends ContextPlugin implements CloudServicesConfig {
-    /**
-     * The authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
-     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
-     */
-    readonly tokenUrl?: TokenUrl;
-    /**
-     * The URL to which the files should be uploaded.
-     */
-    readonly uploadUrl?: string;
-    /**
-     * The URL for web socket communication, used by the `RealTimeCollaborativeEditing` plugin. Every customer (organization in the CKEditor
-     * Ecosystem dashboard) has their own, unique URLs to communicate with CKEditor Cloud Services. The URL can be found in the
-     * CKEditor Ecosystem customer dashboard.
-     *
-     * Note: Unlike most plugins, `RealTimeCollaborativeEditing` is not included in any CKEditor 5 build and needs to be installed manually.
-     * Check [Collaboration overview](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/overview.html) for more details.
-     */
-    readonly webSocketUrl?: string;
-    /**
-     * An optional parameter used for integration with CKEditor Cloud Services when uploading the editor build to cloud services.
-     *
-     * Whenever the editor build or the configuration changes, this parameter should be set to a new, unique value to differentiate
-     * the new bundle (build + configuration) from the old ones.
-     */
-    readonly bundleVersion?: string;
-    /**
-     * Other plugins use this token for the authorization process. It handles token requesting and refreshing.
-     * Its value is `null` when {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} is not provided.
-     *
-     * @readonly
-     */
-    token: InitializedToken | null;
-    /**
-     * A map of token object instances keyed by the token URLs.
-     */
-    private readonly _tokens;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CloudServices";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CloudServicesCore];
-    /**
-     * @inheritDoc
-     */
-    init(): Promise<void>;
-    /**
-     * Registers an additional authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
-     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
-     *
-     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
-     */
-    registerTokenUrl(tokenUrl: TokenUrl): Promise<InitializedToken>;
-    /**
-     * Returns an authentication token provider previously registered by {@link #registerTokenUrl}.
-     *
-     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
-     */
-    getTokenFor(tokenUrl: TokenUrl): InitializedToken;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}
+/**
+ * @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/cloudservices
+ */
+import { ContextPlugin } from 'ckeditor5/src/core';
+import CloudServicesCore from './cloudservicescore';
+import type { CloudServicesConfig, TokenUrl } from './cloudservicesconfig';
+import type { InitializedToken } from './token/token';
+/**
+ * Plugin introducing the integration between CKEditor 5 and CKEditor Cloud Services .
+ *
+ * It initializes the token provider based on
+ * the {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig `config.cloudService`}.
+ */
+export default class CloudServices extends ContextPlugin implements CloudServicesConfig {
+    /**
+     * The authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
+     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
+     */
+    readonly tokenUrl?: TokenUrl;
+    /**
+     * The URL to which the files should be uploaded.
+     */
+    readonly uploadUrl?: string;
+    /**
+     * The URL for web socket communication, used by the `RealTimeCollaborativeEditing` plugin. Every customer (organization in the CKEditor
+     * Ecosystem dashboard) has their own, unique URLs to communicate with CKEditor Cloud Services. The URL can be found in the
+     * CKEditor Ecosystem customer dashboard.
+     *
+     * Note: Unlike most plugins, `RealTimeCollaborativeEditing` is not included in any CKEditor 5 build and needs to be installed manually.
+     * Check [Collaboration overview](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/overview.html) for more details.
+     */
+    readonly webSocketUrl?: string;
+    /**
+     * An optional parameter used for integration with CKEditor Cloud Services when uploading the editor build to cloud services.
+     *
+     * Whenever the editor build or the configuration changes, this parameter should be set to a new, unique value to differentiate
+     * the new bundle (build + configuration) from the old ones.
+     */
+    readonly bundleVersion?: string;
+    /**
+     * Other plugins use this token for the authorization process. It handles token requesting and refreshing.
+     * Its value is `null` when {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} is not provided.
+     *
+     * @readonly
+     */
+    token: InitializedToken | null;
+    /**
+     * A map of token object instances keyed by the token URLs.
+     */
+    private readonly _tokens;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CloudServices";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof CloudServicesCore];
+    /**
+     * @inheritDoc
+     */
+    init(): Promise<void>;
+    /**
+     * Registers an additional authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
+     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
+     *
+     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
+     */
+    registerTokenUrl(tokenUrl: TokenUrl): Promise<InitializedToken>;
+    /**
+     * Returns an authentication token provider previously registered by {@link #registerTokenUrl}.
+     *
+     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
+     */
+    getTokenFor(tokenUrl: TokenUrl): InitializedToken;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}

package/src/cloudservices.js

@@ -1,103 +1,103 @@
-/**
- * @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/cloudservices
- */
-import { ContextPlugin } from 'ckeditor5/src/core';
-import { CKEditorError } from 'ckeditor5/src/utils';
-import CloudServicesCore from './cloudservicescore';
-/**
- * Plugin introducing the integration between CKEditor 5 and CKEditor Cloud Services .
- *
- * It initializes the token provider based on
- * the {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig `config.cloudService`}.
- */
-export default class CloudServices extends ContextPlugin {
-    constructor() {
-        super(...arguments);
-        /**
-         * Other plugins use this token for the authorization process. It handles token requesting and refreshing.
-         * Its value is `null` when {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} is not provided.
-         *
-         * @readonly
-         */
-        this.token = null;
-        /**
-         * A map of token object instances keyed by the token URLs.
-         */
-        this._tokens = new Map();
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'CloudServices';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [CloudServicesCore];
-    }
-    /**
-     * @inheritDoc
-     */
-    async init() {
-        const config = this.context.config;
-        const options = config.get('cloudServices') || {};
-        for (const [key, value] of Object.entries(options)) {
-            this[key] = value;
-        }
-        if (!this.tokenUrl) {
-            this.token = null;
-            return;
-        }
-        const cloudServicesCore = this.context.plugins.get('CloudServicesCore');
-        this.token = await cloudServicesCore.createToken(this.tokenUrl).init();
-        this._tokens.set(this.tokenUrl, this.token);
-    }
-    /**
-     * Registers an additional authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
-     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
-     *
-     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
-     */
-    async registerTokenUrl(tokenUrl) {
-        // Reuse the token instance in case of multiple features using the same token URL.
-        if (this._tokens.has(tokenUrl)) {
-            return this.getTokenFor(tokenUrl);
-        }
-        const cloudServicesCore = this.context.plugins.get('CloudServicesCore');
-        const token = await cloudServicesCore.createToken(tokenUrl).init();
-        this._tokens.set(tokenUrl, token);
-        return token;
-    }
-    /**
-     * Returns an authentication token provider previously registered by {@link #registerTokenUrl}.
-     *
-     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
-     */
-    getTokenFor(tokenUrl) {
-        const token = this._tokens.get(tokenUrl);
-        if (!token) {
-            /**
-             * The provided `tokenUrl` was not registered by {@link module:cloud-services/cloudservices~CloudServices#registerTokenUrl}.
-             *
-             * @error cloudservices-token-not-registered
-             */
-            throw new CKEditorError('cloudservices-token-not-registered', this);
-        }
-        return token;
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        for (const token of this._tokens.values()) {
-            token.destroy();
-        }
-    }
-}
+/**
+ * @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/cloudservices
+ */
+import { ContextPlugin } from 'ckeditor5/src/core';
+import { CKEditorError } from 'ckeditor5/src/utils';
+import CloudServicesCore from './cloudservicescore';
+/**
+ * Plugin introducing the integration between CKEditor 5 and CKEditor Cloud Services .
+ *
+ * It initializes the token provider based on
+ * the {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig `config.cloudService`}.
+ */
+export default class CloudServices extends ContextPlugin {
+    constructor() {
+        super(...arguments);
+        /**
+         * Other plugins use this token for the authorization process. It handles token requesting and refreshing.
+         * Its value is `null` when {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} is not provided.
+         *
+         * @readonly
+         */
+        this.token = null;
+        /**
+         * A map of token object instances keyed by the token URLs.
+         */
+        this._tokens = new Map();
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CloudServices';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [CloudServicesCore];
+    }
+    /**
+     * @inheritDoc
+     */
+    async init() {
+        const config = this.context.config;
+        const options = config.get('cloudServices') || {};
+        for (const [key, value] of Object.entries(options)) {
+            this[key] = value;
+        }
+        if (!this.tokenUrl) {
+            this.token = null;
+            return;
+        }
+        const cloudServicesCore = this.context.plugins.get('CloudServicesCore');
+        this.token = await cloudServicesCore.createToken(this.tokenUrl).init();
+        this._tokens.set(this.tokenUrl, this.token);
+    }
+    /**
+     * Registers an additional authentication token URL for CKEditor Cloud Services or a callback to the token value promise. See the
+     * {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl} for more details.
+     *
+     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
+     */
+    async registerTokenUrl(tokenUrl) {
+        // Reuse the token instance in case of multiple features using the same token URL.
+        if (this._tokens.has(tokenUrl)) {
+            return this.getTokenFor(tokenUrl);
+        }
+        const cloudServicesCore = this.context.plugins.get('CloudServicesCore');
+        const token = await cloudServicesCore.createToken(tokenUrl).init();
+        this._tokens.set(tokenUrl, token);
+        return token;
+    }
+    /**
+     * Returns an authentication token provider previously registered by {@link #registerTokenUrl}.
+     *
+     * @param tokenUrl The authentication token URL for CKEditor Cloud Services or a callback to the token value promise.
+     */
+    getTokenFor(tokenUrl) {
+        const token = this._tokens.get(tokenUrl);
+        if (!token) {
+            /**
+             * The provided `tokenUrl` was not registered by {@link module:cloud-services/cloudservices~CloudServices#registerTokenUrl}.
+             *
+             * @error cloudservices-token-not-registered
+             */
+            throw new CKEditorError('cloudservices-token-not-registered', this);
+        }
+        return token;
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        for (const token of this._tokens.values()) {
+            token.destroy();
+        }
+    }
+}