@ckeditor/ckeditor5-editor-multi-root 48.0.0-alpha.8 → 48.0.0

package/dist/augmentation.d.ts

@@ -19,7 +19,7 @@ declare module '@ckeditor/ckeditor5-core' {
          * HTML). In roots attributes, for each root, you can store arbitrary key-value pairs with attributes connected with that root.
          * Use it to store any custom data that is specific to your integration or custom features.
          *
-         * Currently, roots attributes are not used only by any official plugins. This is a mechanism that is prepared for custom features
+         * Currently, any official plugins do not use root attributes. This is a mechanism that is prepared for custom features
          * and non-standard integrations. If you do not provide any custom feature that would use root attributes, you do not need to
          * handle (save and load) this property.
          *
@@ -87,8 +87,12 @@ declare module '@ckeditor/ckeditor5-core' {
         /**
          * Flag for the root that exist in the document but is not initially loaded by the editor.
          *
-         * **Important! Lazy roots loading is an experimental feature, and may become deprecated. Be advised of the following
-         * known limitations:**
+         * **This property has been deprecated and will be removed in the future versions of CKEditor.**
+         *
+         * **Note: This configuration option is supported only by the
+         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor multi-root} editor type.**
+         *
+         * **Important! Lazy roots loading is an experimental feature. Be advised of the following known limitations:**
          *
          * * **Real-time collaboration integrations that use
          * [uploaded editor bundles](https://ckeditor.com/docs/cs/latest/guides/collaboration/editor-bundle.html) are not supported. Using
@@ -106,11 +110,6 @@ declare module '@ckeditor/ckeditor5-core' {
          * This is useful for handling big documents that contain hundreds of roots, or contain very large roots, which may have
          * impact editor performance if loaded all at once.
          *
-         * **Note: This configuration option is supported only by the
-         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor multi-root} editor type.**
-         *
-         * **Note: This property has been deprecated and will be removed in the future versions of CKEditor.**
-         *
          * @deprecated
          */
         lazyLoad?: boolean;

package/dist/index.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 import { Editor, normalizeMultiRootEditorConstructorParams, normalizeRootsConfig, secureSourceElement } from '@ckeditor/ckeditor5-core/dist/index.js';
-import { logWarning, CKEditorError, decodeLicenseKey, isFeatureBlockedByLicenseKey, setDataInElement } from '@ckeditor/ckeditor5-utils/dist/index.js';
+import { CKEditorError, logWarning, decodeLicenseKey, isFeatureBlockedByLicenseKey, setDataInElement } from '@ckeditor/ckeditor5-utils/dist/index.js';
 import { EditorUI, EditorUIView, ToolbarView, MenuBarView, InlineEditableUIView } from '@ckeditor/ckeditor5-ui/dist/index.js';
 import { enableViewPlaceholder } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { isElement as isElement$1 } from 'es-toolkit/compat';
@@ -322,10 +322,7 @@ import { isElement as isElement$1 } from 'es-toolkit/compat';
         const { sourceElementsOrData, editorConfig } = normalizeMultiRootEditorConstructorParams(sourceElementsOrDataOrConfig, config);
         super(editorConfig);
         normalizeRootsConfig(sourceElementsOrData, this.config, false);
-        if (isElement(this.config.get('attachTo'))) {
-            // Documented in core/editor/editorconfig.ts.
-            logWarning('editor-create-attachto-ignored');
-        }
+        normalizeRootsAttributesConfig(this.config);
         if (this.config.get('lazyRoots')) {
             /**
 			 * Using deprecated `config.lazyRoots` configuration option.
@@ -334,14 +331,6 @@ import { isElement as isElement$1 } from 'es-toolkit/compat';
 			 * @error multi-root-editor-root-deprecated-config-lazy-roots
 			 */ throw new CKEditorError('multi-root-editor-root-deprecated-config-lazy-roots', null);
         }
-        if (this.config.get('rootsAttributes')) {
-            /**
-			 * Using deprecated `config.rootsAttributes` configuration option.
-			 * Use `config.roots.<rootName>.modelAttributes` instead.
-			 *
-			 * @error multi-root-editor-root-deprecated-config-roots-attributes
-			 */ throw new CKEditorError('multi-root-editor-root-deprecated-config-roots-attributes', null);
-        }
         // From this point use only normalized `roots.<rootName>.element`, etc.
         const rootsConfig = Object.entries(this.config.get('roots'));
         this.sourceElements = {};
@@ -929,6 +918,35 @@ import { isElement as isElement$1 } from 'es-toolkit/compat';
             config[key]
         ]).filter(([, value])=>value !== undefined));
 }
+/**
+ * Normalize legacy `config.rootsAttributes` config option to `config.roots.<rootName>.modelAttributes`.
+ */ function normalizeRootsAttributesConfig(config) {
+    if (config.get('rootsAttributes')) {
+        const rootsAttributes = config.get('rootsAttributes');
+        const rootsConfig = config.get('roots');
+        for (const [rootName, attributes] of Object.entries(rootsAttributes)){
+            const rootConfig = rootsConfig[rootName];
+            if (!rootConfig) {
+                /**
+				 * Trying to set attributes on a non-existing root.
+				 *
+				 * Roots specified in `config.rootsAttributes` do not match initial editor roots.
+				 *
+				 * @error multi-root-editor-root-attributes-no-root
+				 */ throw new CKEditorError('multi-root-editor-root-attributes-no-root', null);
+            }
+            if (Object.keys(rootConfig.modelAttributes || {}).length) {
+                /**
+				 * Trying to set attributes using deprecated `config.rootsAttributes` on a root that has already
+				 * defined attributes using `config.roots.<rootName>.modelAttributes`.
+				 *
+				 * @error multi-root-editor-root-attributes-conflict
+				 */ throw new CKEditorError('multi-root-editor-root-attributes-conflict', null);
+            }
+            config.set(`roots.${rootName}.modelAttributes`, attributes);
+        }
+    }
+}
 function isElement(value) {
     return isElement$1(value);
 }