@ckeditor/ckeditor5-collaboration-core 41.3.1 → 41.4.0

package/dist/translations/ur.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x79e3a2=>{const {ur:{dictionary:_0x43c127,getPluralForm:_0x15e73}}={'ur':{'dictionary':{'Anonymous':'بے\x20نام','Yes':'ہاں','No':'ناں','Are\x20you\x20sure?':'واقعی؟'},'getPluralForm':_0xd33347=>0x1!=_0xd33347}};_0x79e3a2['ur']||={'dictionary':{},'getPluralForm':null},_0x79e3a2['ur']['dictionary']=Object['assign'](_0x79e3a2['ur']['dictionary'],_0x43c127),_0x79e3a2['ur']['getPluralForm']=_0x15e73;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/vi.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @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 { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/vi.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'vi':{'dictionary':{'Anonymous':'Ẩn\x20danh','Yes':'Có','No':'Không','Are\x20you\x20sure?':'Bạn\x20có\x20chắc\x20chắn\x20không?'},'getPluralForm':_0x2e9ab5=>0x0}};

package/dist/translations/vi.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x240310=>{const {vi:{dictionary:_0x625317,getPluralForm:_0x50ffe2}}={'vi':{'dictionary':{'Anonymous':'Ẩn\x20danh','Yes':'Có','No':'Không','Are\x20you\x20sure?':'Bạn\x20có\x20chắc\x20chắn\x20không?'},'getPluralForm':_0xbef068=>0x0}};_0x240310['vi']||={'dictionary':{},'getPluralForm':null},_0x240310['vi']['dictionary']=Object['assign'](_0x240310['vi']['dictionary'],_0x625317),_0x240310['vi']['getPluralForm']=_0x50ffe2;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/zh-cn.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @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 { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh-cn.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh-cn':{'dictionary':{'Anonymous':'匿名用户','Yes':'确定','No':'取消','Are\x20you\x20sure?':'你确定吗？'},'getPluralForm':_0x4c97bb=>0x0}};

package/dist/translations/zh-cn.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x112bfb=>{const {'zh-cn':{dictionary:_0x1886fa,getPluralForm:_0x59502e}}={'zh-cn':{'dictionary':{'Anonymous':'匿名用户','Yes':'确定','No':'取消','Are\x20you\x20sure?':'你确定吗？'},'getPluralForm':_0x212319=>0x0}};_0x112bfb['zh-cn']||={'dictionary':{},'getPluralForm':null},_0x112bfb['zh-cn']['dictionary']=Object['assign'](_0x112bfb['zh-cn']['dictionary'],_0x1886fa),_0x112bfb['zh-cn']['getPluralForm']=_0x59502e;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/zh.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @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 { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh':{'dictionary':{'Anonymous':'匿名者','Yes':'好','No':'先不要','Are\x20you\x20sure?':'確定做此操作？'},'getPluralForm':_0x570ce3=>0x0}};

package/dist/translations/zh.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x291632=>{const {zh:{dictionary:_0x896827,getPluralForm:_0x488c5f}}={'zh':{'dictionary':{'Anonymous':'匿名者','Yes':'好','No':'先不要','Are\x20you\x20sure?':'確定做此操作？'},'getPluralForm':_0x290b12=>0x0}};_0x291632['zh']||={'dictionary':{},'getPluralForm':null},_0x291632['zh']['dictionary']=Object['assign'](_0x291632['zh']['dictionary'],_0x896827),_0x291632['zh']['getPluralForm']=_0x488c5f;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/types/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/types/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/types/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/types/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;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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
+ */
+export { default as Permissions } from './permissions.js';
+export { default as Users, type User } from './users.js';
+export { default as UserView } from './users/view/userview.js';
+export { default as getDateTimeFormatter } from './utils/getdatetimeformatter.js';
+export { default as getMarkerDomElement, getAllMarkersDomElementsSorted } from './utils/getmarkerdomelement.js';
+export { default as trimHtml } from './utils/trim-html.js';
+export { default as ConfirmMixin } from './utils/confirmmixin.js';
+export { default as hashObject } from './utils/hashobject.js';
+export { default as sanitizeEditorConfig } from './utils/sanitizeEditorConfig.js';
+export { default as surroundingMarkersDetector } from './utils/surroundingmarkersdetector.js';
+export type { default as CollaborationOperation, InsertCollaborationOperation, SplitCollaborationOperation, MarkerCollaborationOperation, MoveCollaborationOperation, MergeCollaborationOperation, RootCollaborationOperation, RootAttributeCollaborationOperation } from './collaborationoperation.js';
+export type { default as CollaborationHistory } from './collaborationhistory.js';
+export type { LocaleConfig, RealTimeCollaborationConfig } from './config.js';
+export * from './suggestionstyles.js';
+import './augmentation.js';

package/dist/types/permissions.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @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/permissions
+ * @publicApi
+ */
+import { ContextPlugin } from 'ckeditor5/src/core.js';
+/**
+ * The `Permissions` plugin manages permissions set for the local user.
+ *
+ * Following is the list of all defined permissions:
+ *
+ * * `document:write` - modify the content of the document, and resolve comment threads created by any user,
+ * * `comment:write` - create, edit and remove own comments and create, remove own comment threads,
+ * and resolve comment threads created by any user,
+ * * `comment:admin` - resolve and remove comment threads created by other users (enables `comment:write`).
+ * * `comment:modify_all` - edit and remove any comments created by other users.
+ *
+ * For example, a user with `comment:write` permission but with no `document:write` permission will be able to add
+ * comments but will not be able to change the document data (comments-only mode).
+ *
+ * By default, the following permissions are set: `document:write`, `comment:write`, `comment:admin`.
+ *
+ * Permissions are handled separately for each channel id (for each editor instance and context instance).
+ *
+ * See also the {@glink features/collaboration/users#user-permissions User permissions} guide to learn how to use this plugin.
+ */
+export default class Permissions extends ContextPlugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Permissions";
+    /**
+     * Sets permissions for editor/context instance with given `channelId`.
+     *
+     * If `channelId` is not set, the channel id of the editor/context to which the plugin was added will be used.
+     * This means that it is not required if the plugin is added to the editor configuration and {@link module:core/context~Context}
+     * is not used.
+     *
+     * @param permissions Permissions to set.
+     * @param channelId The channel ID.
+     */
+    setPermissions(permissions: Array<string>, channelId?: string): void;
+}

package/dist/types/suggestionstyles.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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 '../theme/suggestion.css';
+import '../theme/suggestionmarker.css';
+import '../theme/integrations/image.css';
+import '../theme/integrations/horizontalline.css';
+import '../theme/integrations/mediaembed.css';
+import '../theme/integrations/pagebreak.css';
+import '../theme/integrations/table.css';
+import '../theme/integrations/codeblock.css';

package/dist/types/users/view/userview.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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/users/view/userview
+ */
+import { View, type TemplateDefinition } from 'ckeditor5/src/ui.js';
+import type { Locale } from 'ckeditor5/src/utils.js';
+import type { User } from '../../users.js';
+import '../../../theme/users.css';
+export default class UserView extends View {
+    name: string;
+    notificationView: TemplateDefinition | null;
+    constructor(locale: Locale, user: User, notificationText?: null | string);
+}