@ckeditor/ckeditor5-editor-multi-root 45.0.0 → 45.1.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-editor-multi-root",
-  "version": "45.0.0",
+  "version": "45.1.0-alpha.0",
   "description": "Multi-root editor implementation for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,11 +12,11 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "45.0.0",
-    "@ckeditor/ckeditor5-engine": "45.0.0",
-    "@ckeditor/ckeditor5-ui": "45.0.0",
-    "@ckeditor/ckeditor5-utils": "45.0.0",
-    "ckeditor5": "45.0.0",
+    "@ckeditor/ckeditor5-core": "45.1.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "45.1.0-alpha.0",
+    "@ckeditor/ckeditor5-ui": "45.1.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "45.1.0-alpha.0",
+    "ckeditor5": "45.1.0-alpha.0",
     "es-toolkit": "1.32.0"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/augmentation.d.ts

@@ -79,6 +79,19 @@ declare module '@ckeditor/ckeditor5-core' {
         /**
          * A list of names of all the roots that exist in the document but are 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:**
+         *
+         * * **Real-time collaboration integrations that use
+         * [uploaded editor bundles](https://ckeditor.com/docs/cs/latest/guides/collaboration/editor-bundle.html) are not supported. Using
+         * lazy roots will lead to unexpected behavior and data loss.**
+         * * **Revision history feature will read and process the whole document on editor initialization, possibly defeating the purpose
+         * of using the lazy roots loading. Additionally, when the document is loaded for the first time, all roots need to be loaded,
+         * to make sure that the initial revision data includes all roots. Otherwise, you may experience data loss.**
+         * * **Multiple features, that require full document data to be loaded, will produce incorrect or confusing results if not all
+         * roots are loaded. These include: bookmarks, find and replace, word count, pagination, document exports, document outline,
+         * and table of contents.**
+         *
          * These roots can be loaded at any time after the editor has been initialized, using
          * {@link module:editor-multi-root/multirooteditor~MultiRootEditor#loadRoot `MultiRootEditor#lazyRoot()`}.
          *

package/src/multirooteditor.d.ts

@@ -234,6 +234,19 @@ export default class MultiRootEditor extends Editor {
      * Loads a root that has previously been declared in {@link module:core/editor/editorconfig~EditorConfig#lazyRoots `lazyRoots`}
      * configuration option.
      *
+     * **Important! Lazy roots loading is an experimental feature, and may become deprecated. 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
+     * lazy roots will lead to unexpected behavior and data loss.**
+     * * **Revision history feature will read and process the whole document on editor initialization, possibly defeating the purpose
+     * of using the lazy roots loading. Additionally, when the document is loaded for the first time, all roots need to be loaded,
+     * to make sure that the initial revision data includes all roots. Otherwise, you may experience data loss.**
+     * * **Multiple features, that require full document data to be loaded, will produce incorrect or confusing results if not all
+     * roots are loaded. These include: bookmarks, find and replace, word count, pagination, document exports, document outline,
+     * and table of contents.**
+     *
      * Only roots specified in the editor config can be loaded. A root cannot be loaded multiple times. A root cannot be unloaded and
      * loading a root cannot be reverted using the undo feature.
      *

package/src/multirooteditor.js

@@ -444,6 +444,19 @@ export default class MultiRootEditor extends Editor {
      * Loads a root that has previously been declared in {@link module:core/editor/editorconfig~EditorConfig#lazyRoots `lazyRoots`}
      * configuration option.
      *
+     * **Important! Lazy roots loading is an experimental feature, and may become deprecated. 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
+     * lazy roots will lead to unexpected behavior and data loss.**
+     * * **Revision history feature will read and process the whole document on editor initialization, possibly defeating the purpose
+     * of using the lazy roots loading. Additionally, when the document is loaded for the first time, all roots need to be loaded,
+     * to make sure that the initial revision data includes all roots. Otherwise, you may experience data loss.**
+     * * **Multiple features, that require full document data to be loaded, will produce incorrect or confusing results if not all
+     * roots are loaded. These include: bookmarks, find and replace, word count, pagination, document exports, document outline,
+     * and table of contents.**
+     *
      * Only roots specified in the editor config can be loaded. A root cannot be loaded multiple times. A root cannot be unloaded and
      * loading a root cannot be reverted using the undo feature.
      *