@ckeditor/ckeditor5-collaboration-core 0.0.0-internal-20241017.0

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+All changes in the package are documented in https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md.

package/LICENSE.md

@@ -0,0 +1,23 @@
+Software License Agreement
+==========================
+
+**CKEditor&nbsp;5 collaboration core** (https://ckeditor.com/collaboration/)<br>
+Copyright (c) 2003–2024, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+
+CKEditor&nbsp;5 collaboration core is licensed under a commercial license and is protected by copyright law.
+For more details about available licensing options please contact us at sales@cksource.com.
+
+Sources of Intellectual Property Included in CKEditor&nbsp;5 collaboration core
+-------------------------------------------------------------------------------
+
+Where not otherwise indicated, all CKEditor&nbsp;5 collaboration core content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
+
+The following libraries are included in CKEditor&nbsp;5 collaboration core under the [MIT license](https://opensource.org/licenses/MIT):
+
+* date-fns - Copyright (c) 2021 Sasha Koss and Lesha Koss https://kossnocorp.mit-license.org.
+* Lodash - Copyright (c) JS Foundation and other contributors https://js.foundation/. Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/.
+
+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.

package/README.md

@@ -0,0 +1,35 @@
+# CKEditor 5 collaboration core
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-collaboration-core.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-collaboration-core)
+
+CKEditor 5 collaboration core is a low-level API that provides base features to support multiple users working together in a rich text editor. It is used in collaborative features such as [comments](https://ckeditor.com/collaboration/comments/), [track changes](https://ckeditor.com/collaboration/track-changes/) or [real-time collaboration](https://ckeditor.com/collaboration/real-time/) in CKEditor 5.
+
+## Documentation
+
+For more information about collaboration features visit [CKEditor 5 collaboration features overview documentation](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/collaboration.html).
+
+Also, make sure you visit the [CKEditor 5 changelog](https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md) whenever a new version of the package is released.
+
+## Installation
+
+```bash
+npm install ckeditor5-premium-features
+```
+
+## Getting support
+
+CKEditor 5 collaboration core comes with outstanding support from a dedicated team of customer care specialists, QA engineers and CKEditor 5 developers. The team will gladly assist you in all aspects from setting up your account to integrating CKEditor 5 collaboration features with your application.
+
+As a licensed CKEditor 5 collaboration features user you can report bugs and request features directly through the CKEditor Ecosystem customer dashboard.
+
+## License
+
+**CKEditor&nbsp;5 collaboration core**<br>
+Copyright (c) 2003–2024, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+
+CKEditor&nbsp;5 collaboration core is licensed under a commercial license and is protected by copyright law.
+For more details about available licensing options please contact us at sales@cksource.com.
+
+### 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.

package/dist/augmentation.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { LocaleConfig, Users } from './index.js';
+import type { RealTimeCollaborationConfig } from './config.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The locale configuration of the editor.
+         */
+        locale?: LocaleConfig;
+        /**
+         * The users plugin configuration.
+         */
+        users?: {
+            /**
+             * User ID value that will be used for the anonymous user.
+             */
+            anonymousUserId?: string;
+            /**
+             * Number of defined colors that are randomly assigned to users.
+             */
+            colorsCount?: number;
+        };
+        /**
+         * The configuration of the real time collaboration feature.
+         *
+         * Read more in {@link module:collaboration-core/config~RealTimeCollaborationConfig}.
+         *
+         * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+         */
+        collaboration?: RealTimeCollaborationConfig;
+    }
+    interface PluginsMap {
+        [Users.pluginName]: Users;
+    }
+}

package/dist/collaborationhistory.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/collaborationhistory
+ * @publicApi
+ */
+import type { default as CollaborationOperation } from './collaborationoperation.js';
+/**
+ * Interface compatible with {@link module:engine/model/history~History} with the difference that it uses
+ * {@link module:collaboration-core/collaborationoperation~CollaborationOperation} instead of regular model operations.
+ */
+export default interface CollaborationHistory {
+    _operations: Array<CollaborationOperation>;
+    version: number;
+    getOperations(fromBaseVersion?: number, toBaseVersion?: number): Array<CollaborationOperation>;
+    getOperation(baseVersion: number): CollaborationOperation | undefined;
+    addOperation(operation: CollaborationOperation): void;
+    reset(): void;
+}

package/dist/collaborationoperation.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/collaborationoperation
+ * @publicApi
+ */
+import type { Operation, InsertOperation, MergeOperation, MoveOperation, SplitOperation, MarkerOperation, RootOperation, RootAttributeOperation } from 'ckeditor5/src/engine.js';
+/**
+ * Extends the {@link module:engine/model/operation/operation operation}.
+ */
+export default interface CollaborationOperation extends Operation {
+    _isInit?: boolean;
+    _authorId?: null | string;
+    _isDisconnection?: boolean;
+    createdAt?: Date;
+    wasUndone?: boolean;
+    affectsData?: Record<string, any>;
+    clone(): CollaborationOperation;
+}
+export type InsertCollaborationOperation = CollaborationOperation & InsertOperation;
+export type MoveCollaborationOperation = CollaborationOperation & MoveOperation;
+export type MergeCollaborationOperation = CollaborationOperation & MergeOperation;
+export type SplitCollaborationOperation = CollaborationOperation & SplitOperation;
+export type MarkerCollaborationOperation = CollaborationOperation & MarkerOperation;
+export type RootCollaborationOperation = CollaborationOperation & RootOperation;
+export type RootAttributeCollaborationOperation = CollaborationOperation & RootAttributeOperation;

package/dist/config.d.ts

@@ -0,0 +1,106 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module collaboration-core/config
+ * @publicApi
+ */
+/**
+ * The locale configuration.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		locale: {
+ * 			// The localization configuration.
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor configuration options}.
+ */
+export interface LocaleConfig {
+    /**
+     * A function that formats date to the custom format. It is used in dates in annotations (balloons) displaying
+     * comments and suggestions details.
+     *
+     * The default formatting can be changed by setting a custom formatting function to `config.locale.dateTimeFormat`.
+     *
+     * ```ts
+     * import format from 'date-fns/format';
+     *
+     * ClassicEditor
+     * 	.create( document.querySelector( '#editor' ), {
+     * 		toolbar: {
+     * 			items: [ 'bold', 'italic', '|', 'comment' ]
+     * 		},
+     * 		sidebar: {
+     * 			container: document.querySelector( '#sidebar' )
+     * 		},
+     * 		locale: {
+     * 			dateTimeFormat: date => format( date, 'dd/MM/yyyy' )
+     * 		}
+     * 	} )
+     * 	.catch( error => console.error( error ) );
+     * ```
+     *
+     * @returns The generated date.
+     */
+    dateTimeFormat?: (date: Date) => string;
+}
+/**
+ * The configuration of the real-time collaboration features.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		collaboration: ... // Collaboration features configuration.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface RealTimeCollaborationConfig {
+    /**
+     * The channel ID is a unique ID that identifies the data loaded in the editor instance or used by
+     * the context instance.
+     *
+     * If specified for the editor, it is the document ID.
+     *
+     * If you are using multiple editors instances at the same time, each of them should use a different
+     * channel ID to connect to a specific document.
+     *
+     * If specified for context, it is the ID for all the data related to context instance.
+     * This ID will be used for data that is not related to an editor instance, for example comments
+     * outside the editor.
+     *
+     * In the case of context, the ID can be an ID of a subpage or a form, or a different entity accordingly
+     * to your application.
+     *
+     * The channel ID can be used to recognize entity to which piece of data belongs in integrations that use `Context`
+     * and context plugins. For example, if you are preparing a custom integration using the comments API,
+     * you can use the channel ID to recognize whether the comment was added to an editor instance
+     * (and which one) or to the context.
+     *
+     * ```ts
+     * ClassicEditor
+     * 	.create( {
+     * 		collaboration: {
+     * 			channelId: 'your-channel-id'
+     * 		}
+     * 	} )
+     * 	.then( ... )
+     * 	.catch( ... );
+     * ```
+     */
+    channelId?: string;
+}