@ckeditor/ckeditor5-editor-multi-root 38.1.1 → 38.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-editor-multi-root",
-  "version": "38.1.1",
+  "version": "38.2.0-alpha.1",
   "description": "Multi-root editor implementation for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -10,8 +10,9 @@
     "ckeditor5-dll"
   ],
   "main": "src/index.js",
+  "type": "module",
   "dependencies": {
-    "ckeditor5": "38.1.1",
+    "ckeditor5": "38.2.0-alpha.1",
     "lodash-es": "^4.17.15"
   },
   "engines": {

package/src/augmentation.d.ts

@@ -1,80 +1,80 @@
-/**
- * @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 RootAttributes } from './multirooteditor';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * Initial roots attributes for the document roots.
-         *
-         * **Note: This configuration option is supported only by the
-         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor multi-root} editor type.**
-         *
-         * **Note: You must provide full set of attributes for each root. If an attribute is not set on a root, set the value to `null`.
-         * Only provided attribute keys will be returned by
-         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor#getRootsAttributes}.**
-         *
-         * Roots attributes hold additional data related to the document roots, in addition to the regular document data (which usually is
-         * 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
-         * 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.
-         *
-         * ```ts
-         * MultiRootEditor.create(
-         * 	// Roots for the editor:
-         * 	{
-         * 		uid1: document.querySelector( '#uid1' ),
-         * 		uid2: document.querySelector( '#uid2' ),
-         * 		uid3: document.querySelector( '#uid3' ),
-         * 		uid4: document.querySelector( '#uid4' )
-         * 	},
-         * 	// Config:
-         * 	{
-         * 		rootsAttributes: {
-         * 			uid1: { order: 20, isLocked: false }, // Third, unlocked.
-         * 			uid2: { order: 10, isLocked: true }, // Second, locked.
-         * 			uid3: { order: 30, isLocked: true }, // Fourth, locked.
-         * 			uid4: { order: 0, isLocked: false } // First, unlocked.
-         * 		}
-         * 	}
-         * )
-         * .then( ... )
-         * .catch( ... );
-         * ```
-         *
-         * Note, that the above code snippet is only an example. You need to implement your own features that will use these attributes.
-         *
-         * Roots attributes can be changed the same way as attributes set on other model nodes:
-         *
-         * ```ts
-         * editor.model.change( writer => {
-         * 	const root = editor.model.getRoot( 'uid3' );
-         *
-         * 	writer.setAttribute( 'order', 40, root );
-         * } );
-         * ```
-         *
-         * You can react to root attributes changes by listening to
-         * {@link module:engine/model/document~Document#event:change:data document `change:data` event}:
-         *
-         * ```ts
-         * editor.model.document.on( 'change:data', () => {
-         * 	const changedRoots = editor.model.document.differ.getChangedRoots();
-         *
-         * 	for ( const change of changedRoots ) {
-         * 		if ( change.attributes ) {
-         * 			const root = editor.model.getRoot( change.name );
-         *
-         * 			// ...
-         * 		}
-         * 	}
-         * } );
-         * ```
-         */
-        rootsAttributes?: Record<string, RootAttributes>;
-    }
-}
+/**
+ * @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 RootAttributes } from './multirooteditor.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * Initial roots attributes for the document roots.
+         *
+         * **Note: This configuration option is supported only by the
+         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor multi-root} editor type.**
+         *
+         * **Note: You must provide full set of attributes for each root. If an attribute is not set on a root, set the value to `null`.
+         * Only provided attribute keys will be returned by
+         * {@link module:editor-multi-root/multirooteditor~MultiRootEditor#getRootsAttributes}.**
+         *
+         * Roots attributes hold additional data related to the document roots, in addition to the regular document data (which usually is
+         * 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
+         * 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.
+         *
+         * ```ts
+         * MultiRootEditor.create(
+         * 	// Roots for the editor:
+         * 	{
+         * 		uid1: document.querySelector( '#uid1' ),
+         * 		uid2: document.querySelector( '#uid2' ),
+         * 		uid3: document.querySelector( '#uid3' ),
+         * 		uid4: document.querySelector( '#uid4' )
+         * 	},
+         * 	// Config:
+         * 	{
+         * 		rootsAttributes: {
+         * 			uid1: { order: 20, isLocked: false }, // Third, unlocked.
+         * 			uid2: { order: 10, isLocked: true }, // Second, locked.
+         * 			uid3: { order: 30, isLocked: true }, // Fourth, locked.
+         * 			uid4: { order: 0, isLocked: false } // First, unlocked.
+         * 		}
+         * 	}
+         * )
+         * .then( ... )
+         * .catch( ... );
+         * ```
+         *
+         * Note, that the above code snippet is only an example. You need to implement your own features that will use these attributes.
+         *
+         * Roots attributes can be changed the same way as attributes set on other model nodes:
+         *
+         * ```ts
+         * editor.model.change( writer => {
+         * 	const root = editor.model.getRoot( 'uid3' );
+         *
+         * 	writer.setAttribute( 'order', 40, root );
+         * } );
+         * ```
+         *
+         * You can react to root attributes changes by listening to
+         * {@link module:engine/model/document~Document#event:change:data document `change:data` event}:
+         *
+         * ```ts
+         * editor.model.document.on( 'change:data', () => {
+         * 	const changedRoots = editor.model.document.differ.getChangedRoots();
+         *
+         * 	for ( const change of changedRoots ) {
+         * 		if ( change.attributes ) {
+         * 			const root = editor.model.getRoot( change.name );
+         *
+         * 			// ...
+         * 		}
+         * 	}
+         * } );
+         * ```
+         */
+        rootsAttributes?: Record<string, RootAttributes>;
+    }
+}

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/index.d.ts

@@ -1,10 +1,10 @@
-/**
- * @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 editor-multi-root
- */
-export { default as MultiRootEditor } from './multirooteditor';
-export type { RootAttributes } from './multirooteditor';
-import './augmentation';
+/**
+ * @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 editor-multi-root
+ */
+export { default as MultiRootEditor } from './multirooteditor.js';
+export type { RootAttributes } from './multirooteditor.js';
+import './augmentation.js';

package/src/index.js

@@ -1,9 +1,9 @@
-/**
- * @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 editor-multi-root
- */
-export { default as MultiRootEditor } from './multirooteditor';
-import './augmentation';
+/**
+ * @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 editor-multi-root
+ */
+export { default as MultiRootEditor } from './multirooteditor.js';
+import './augmentation.js';