@ckeditor/ckeditor5-real-time-collaboration 48.2.0 → 48.3.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/dist/augmentation.d.ts +67 -67
  2. package/dist/common-translations.d.ts +6 -6
  3. package/dist/config.d.ts +43 -43
  4. package/dist/index.d.ts +19 -19
  5. package/dist/index.js +6 -6
  6. package/dist/presencelist/presencelistui.d.ts +54 -54
  7. package/dist/presencelist/view/presencecounterview.d.ts +10 -10
  8. package/dist/presencelist/view/presencedropdownlistitemview.d.ts +14 -14
  9. package/dist/presencelist/view/presencedropdownlistview.d.ts +0 -4
  10. package/dist/presencelist/view/presenceinlinelistitemview.d.ts +15 -15
  11. package/dist/presencelist/view/presenceinlinelistview.d.ts +34 -34
  12. package/dist/presencelist/view/presencelistview.d.ts +5 -4
  13. package/dist/presencelist.d.ts +32 -32
  14. package/dist/realtimecollaborativecomments/cloudservicescommentsadapter.d.ts +56 -56
  15. package/dist/realtimecollaborativecomments.d.ts +40 -40
  16. package/dist/realtimecollaborativeediting/realtimecollaborationclient.d.ts +129 -140
  17. package/dist/realtimecollaborativeediting/sessions.d.ts +115 -117
  18. package/dist/realtimecollaborativeediting/usermarkers.d.ts +46 -46
  19. package/dist/realtimecollaborativeediting/websocketgateway.d.ts +59 -59
  20. package/dist/realtimecollaborativeediting.d.ts +29 -29
  21. package/dist/realtimecollaborativerevisionhistory/cloudservicesrevisionhistoryadapter.d.ts +53 -53
  22. package/dist/realtimecollaborativerevisionhistory.d.ts +33 -33
  23. package/dist/realtimecollaborativetrackchanges/cloudservicestrackchangesadapter.d.ts +47 -47
  24. package/dist/realtimecollaborativetrackchanges.d.ts +31 -31
  25. package/dist/translations/af.js +1 -1
  26. package/dist/translations/af.umd.js +1 -1
  27. package/dist/translations/ar.js +1 -1
  28. package/dist/translations/ar.umd.js +1 -1
  29. package/dist/translations/ast.js +1 -1
  30. package/dist/translations/ast.umd.js +1 -1
  31. package/dist/translations/az.js +1 -1
  32. package/dist/translations/az.umd.js +1 -1
  33. package/dist/translations/be.js +1 -1
  34. package/dist/translations/be.umd.js +1 -1
  35. package/dist/translations/bg.js +1 -1
  36. package/dist/translations/bg.umd.js +1 -1
  37. package/dist/translations/bn.js +1 -1
  38. package/dist/translations/bn.umd.js +1 -1
  39. package/dist/translations/bs.js +1 -1
  40. package/dist/translations/bs.umd.js +1 -1
  41. package/dist/translations/ca.js +1 -1
  42. package/dist/translations/ca.umd.js +1 -1
  43. package/dist/translations/cs.js +1 -1
  44. package/dist/translations/cs.umd.js +1 -1
  45. package/dist/translations/da.js +1 -1
  46. package/dist/translations/da.umd.js +1 -1
  47. package/dist/translations/de-ch.js +1 -1
  48. package/dist/translations/de-ch.umd.js +1 -1
  49. package/dist/translations/de.js +1 -1
  50. package/dist/translations/de.umd.js +1 -1
  51. package/dist/translations/el.js +1 -1
  52. package/dist/translations/el.umd.js +1 -1
  53. package/dist/translations/en-au.js +1 -1
  54. package/dist/translations/en-au.umd.js +1 -1
  55. package/dist/translations/en-gb.js +1 -1
  56. package/dist/translations/en-gb.umd.js +1 -1
  57. package/dist/translations/en.js +1 -1
  58. package/dist/translations/en.umd.js +1 -1
  59. package/dist/translations/eo.js +1 -1
  60. package/dist/translations/eo.umd.js +1 -1
  61. package/dist/translations/es-co.js +1 -1
  62. package/dist/translations/es-co.umd.js +1 -1
  63. package/dist/translations/es.js +1 -1
  64. package/dist/translations/es.umd.js +1 -1
  65. package/dist/translations/et.js +1 -1
  66. package/dist/translations/et.umd.js +1 -1
  67. package/dist/translations/eu.js +1 -1
  68. package/dist/translations/eu.umd.js +1 -1
  69. package/dist/translations/fa.js +1 -1
  70. package/dist/translations/fa.umd.js +1 -1
  71. package/dist/translations/fi.js +1 -1
  72. package/dist/translations/fi.umd.js +1 -1
  73. package/dist/translations/fr.js +1 -1
  74. package/dist/translations/fr.umd.js +1 -1
  75. package/dist/translations/gl.js +1 -1
  76. package/dist/translations/gl.umd.js +1 -1
  77. package/dist/translations/gu.js +1 -1
  78. package/dist/translations/gu.umd.js +1 -1
  79. package/dist/translations/he.js +1 -1
  80. package/dist/translations/he.umd.js +1 -1
  81. package/dist/translations/hi.js +1 -1
  82. package/dist/translations/hi.umd.js +1 -1
  83. package/dist/translations/hr.js +1 -1
  84. package/dist/translations/hr.umd.js +1 -1
  85. package/dist/translations/hu.js +1 -1
  86. package/dist/translations/hu.umd.js +1 -1
  87. package/dist/translations/hy.js +1 -1
  88. package/dist/translations/hy.umd.js +1 -1
  89. package/dist/translations/id.js +1 -1
  90. package/dist/translations/id.umd.js +1 -1
  91. package/dist/translations/it.js +1 -1
  92. package/dist/translations/it.umd.js +1 -1
  93. package/dist/translations/ja.js +1 -1
  94. package/dist/translations/ja.umd.js +1 -1
  95. package/dist/translations/jv.js +1 -1
  96. package/dist/translations/jv.umd.js +1 -1
  97. package/dist/translations/kk.js +1 -1
  98. package/dist/translations/kk.umd.js +1 -1
  99. package/dist/translations/km.js +1 -1
  100. package/dist/translations/km.umd.js +1 -1
  101. package/dist/translations/kn.js +1 -1
  102. package/dist/translations/kn.umd.js +1 -1
  103. package/dist/translations/ko.js +1 -1
  104. package/dist/translations/ko.umd.js +1 -1
  105. package/dist/translations/ku.js +1 -1
  106. package/dist/translations/ku.umd.js +1 -1
  107. package/dist/translations/lt.js +1 -1
  108. package/dist/translations/lt.umd.js +1 -1
  109. package/dist/translations/lv.js +1 -1
  110. package/dist/translations/lv.umd.js +1 -1
  111. package/dist/translations/ms.js +1 -1
  112. package/dist/translations/ms.umd.js +1 -1
  113. package/dist/translations/nb.js +1 -1
  114. package/dist/translations/nb.umd.js +1 -1
  115. package/dist/translations/ne.js +1 -1
  116. package/dist/translations/ne.umd.js +1 -1
  117. package/dist/translations/nl.js +1 -1
  118. package/dist/translations/nl.umd.js +1 -1
  119. package/dist/translations/no.js +1 -1
  120. package/dist/translations/no.umd.js +1 -1
  121. package/dist/translations/oc.js +1 -1
  122. package/dist/translations/oc.umd.js +1 -1
  123. package/dist/translations/pl.js +1 -1
  124. package/dist/translations/pl.umd.js +1 -1
  125. package/dist/translations/pt-br.js +1 -1
  126. package/dist/translations/pt-br.umd.js +1 -1
  127. package/dist/translations/pt.js +1 -1
  128. package/dist/translations/pt.umd.js +1 -1
  129. package/dist/translations/ro.js +1 -1
  130. package/dist/translations/ro.umd.js +1 -1
  131. package/dist/translations/ru.js +1 -1
  132. package/dist/translations/ru.umd.js +1 -1
  133. package/dist/translations/si.js +1 -1
  134. package/dist/translations/si.umd.js +1 -1
  135. package/dist/translations/sk.js +1 -1
  136. package/dist/translations/sk.umd.js +1 -1
  137. package/dist/translations/sl.js +1 -1
  138. package/dist/translations/sl.umd.js +1 -1
  139. package/dist/translations/sq.js +1 -1
  140. package/dist/translations/sq.umd.js +1 -1
  141. package/dist/translations/sr-latn.js +1 -1
  142. package/dist/translations/sr-latn.umd.js +1 -1
  143. package/dist/translations/sr.js +1 -1
  144. package/dist/translations/sr.umd.js +1 -1
  145. package/dist/translations/sv.js +1 -1
  146. package/dist/translations/sv.umd.js +1 -1
  147. package/dist/translations/th.js +1 -1
  148. package/dist/translations/th.umd.js +1 -1
  149. package/dist/translations/ti.js +1 -1
  150. package/dist/translations/ti.umd.js +1 -1
  151. package/dist/translations/tk.js +1 -1
  152. package/dist/translations/tk.umd.js +1 -1
  153. package/dist/translations/tr.js +1 -1
  154. package/dist/translations/tr.umd.js +1 -1
  155. package/dist/translations/tt.js +1 -1
  156. package/dist/translations/tt.umd.js +1 -1
  157. package/dist/translations/ug.js +1 -1
  158. package/dist/translations/ug.umd.js +1 -1
  159. package/dist/translations/uk.js +1 -1
  160. package/dist/translations/uk.umd.js +1 -1
  161. package/dist/translations/ur.js +1 -1
  162. package/dist/translations/ur.umd.js +1 -1
  163. package/dist/translations/uz.js +1 -1
  164. package/dist/translations/uz.umd.js +1 -1
  165. package/dist/translations/vi.js +1 -1
  166. package/dist/translations/vi.umd.js +1 -1
  167. package/dist/translations/zh-cn.js +1 -1
  168. package/dist/translations/zh-cn.umd.js +1 -1
  169. package/dist/translations/zh.js +1 -1
  170. package/dist/translations/zh.umd.js +1 -1
  171. package/package.json +13 -13
@@ -1,59 +1,59 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist/presencelistui
7
- * @publicApi
8
- */
9
- import { ContextPlugin, type Context, type Editor } from '@ckeditor/ckeditor5-core';
10
- import { Sessions } from '../realtimecollaborativeediting/sessions.js';
6
+ * @module real-time-collaboration/presencelist/presencelistui
7
+ * @publicApi
8
+ */
9
+ import { ContextPlugin, type Context, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
10
+ import { Sessions } from "../realtimecollaborativeediting/sessions.js";
11
11
  /**
12
- * The `PresenceListUI` plugin is a part of the {@link module:real-time-collaboration/presencelist~PresenceList}
13
- * and handles the UI part of the plugin.
14
- *
15
- * The presence list UI has two main modes of displaying users list:
16
- *
17
- * * inline (default), which shows users next to each other, and
18
- * * collapsed, which shows users in a dropdown.
19
- *
20
- * By default, the list also displays the {@link module:collaboration-core/users~Users#me local user}.
21
- */
12
+ * The `PresenceListUI` plugin is a part of the {@link module:real-time-collaboration/presencelist~PresenceList}
13
+ * and handles the UI part of the plugin.
14
+ *
15
+ * The presence list UI has two main modes of displaying users list:
16
+ *
17
+ * * inline (default), which shows users next to each other, and
18
+ * * collapsed, which shows users in a dropdown.
19
+ *
20
+ * By default, the list also displays the {@link module:collaboration-core/users~Users#me local user}.
21
+ */
22
22
  export declare class PresenceListUI extends ContextPlugin {
23
- /**
24
- * @inheritDoc
25
- */
26
- static get pluginName(): "PresenceListUI";
27
- /**
28
- * @inheritDoc
29
- */
30
- static get isOfficialPlugin(): true;
31
- /**
32
- * @inheritDoc
33
- */
34
- static get isPremiumPlugin(): true;
35
- /**
36
- * @inheritDoc
37
- */
38
- constructor(context: Context | Editor);
39
- /**
40
- * @inheritDoc
41
- */
42
- static get requires(): readonly [typeof Sessions];
43
- /**
44
- * @inheritDoc
45
- */
46
- init(): void;
47
- /**
48
- * Creates and shows dropdown list with all connected users.
49
- */
50
- showDropdown(): void;
51
- /**
52
- * Hides and destroys dropdown list with all connected users.
53
- */
54
- hideDropdown(): void;
55
- /**
56
- * @inheritDoc
57
- */
58
- destroy(): void;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get pluginName(): "PresenceListUI";
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ static override get isOfficialPlugin(): true;
31
+ /**
32
+ * @inheritDoc
33
+ */
34
+ static override get isPremiumPlugin(): true;
35
+ /**
36
+ * @inheritDoc
37
+ */
38
+ constructor(context: Context | Editor);
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ static get requires(): PluginDependenciesOf<[Sessions]>;
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ init(): void;
47
+ /**
48
+ * Creates and shows dropdown list with all connected users.
49
+ */
50
+ showDropdown(): void;
51
+ /**
52
+ * Hides and destroys dropdown list with all connected users.
53
+ */
54
+ hideDropdown(): void;
55
+ /**
56
+ * @inheritDoc
57
+ */
58
+ override destroy(): void;
59
59
  }
@@ -1,14 +1,14 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist/view/presencecounterview
7
- */
8
- import { View } from '@ckeditor/ckeditor5-ui';
9
- import { type Locale } from '@ckeditor/ckeditor5-utils';
6
+ * @module real-time-collaboration/presencelist/view/presencecounterview
7
+ */
8
+ import { View } from "@ckeditor/ckeditor5-ui";
9
+ import { type Locale } from "@ckeditor/ckeditor5-utils";
10
10
  export declare class PresenceCounterView extends View {
11
- usersCount: number;
12
- isHidden: boolean;
13
- constructor(locale: Locale, collapseAt?: number);
11
+ usersCount: number;
12
+ isHidden: boolean;
13
+ constructor(locale: Locale, collapseAt?: number);
14
14
  }
@@ -1,18 +1,18 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist/view/presencedropdownlistitemview
7
- */
8
- import { ListItemView } from '@ckeditor/ckeditor5-ui';
9
- import type { Locale } from '@ckeditor/ckeditor5-utils';
10
- import { UserView, type User } from '@ckeditor/ckeditor5-collaboration-core';
6
+ * @module real-time-collaboration/presencelist/view/presencedropdownlistitemview
7
+ */
8
+ import { ListItemView } from "@ckeditor/ckeditor5-ui";
9
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
10
+ import { UserView, type User } from "@ckeditor/ckeditor5-collaboration-core";
11
11
  export declare class PresenceDropdownListItemView extends ListItemView {
12
- userView: UserView;
13
- constructor(locale: Locale, user: User, isButton: boolean);
14
- /**
15
- * Focuses the list item.
16
- */
17
- focus(): void;
12
+ userView: UserView;
13
+ constructor(locale: Locale, user: User, isButton: boolean);
14
+ /**
15
+ * Focuses the list item.
16
+ */
17
+ override focus(): void;
18
18
  }
@@ -1,5 +1 @@
1
- /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
5
1
  export {};
@@ -1,22 +1,22 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist/view/presenceinlinelistitemview
7
- */
8
- import { View } from '@ckeditor/ckeditor5-ui';
9
- import type { Locale } from '@ckeditor/ckeditor5-utils';
10
- import { UserView, type User } from '@ckeditor/ckeditor5-collaboration-core';
6
+ * @module real-time-collaboration/presencelist/view/presenceinlinelistitemview
7
+ */
8
+ import { View } from "@ckeditor/ckeditor5-ui";
9
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
10
+ import { UserView, type User } from "@ckeditor/ckeditor5-collaboration-core";
11
11
  export declare class PresenceInlineListItemView extends View {
12
- isFocusable: boolean;
13
- hasTooltip: boolean;
14
- tooltipPosition: string;
15
- userView: UserView;
16
- markerView: MarkerView;
17
- constructor(locale: Locale, user: User, isButton: boolean);
12
+ isFocusable: boolean;
13
+ hasTooltip: boolean;
14
+ tooltipPosition: string;
15
+ userView: UserView;
16
+ markerView: MarkerView;
17
+ constructor(locale: Locale, user: User, isButton: boolean);
18
18
  }
19
19
  declare class MarkerView extends View {
20
- constructor(locale: Locale, user: User);
20
+ constructor(locale: Locale, user: User);
21
21
  }
22
22
  export {};
@@ -1,38 +1,38 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist/view/presenceinlinelistview
7
- */
8
- import { View, type FocusableView, type ViewCollection } from '@ckeditor/ckeditor5-ui';
9
- import { type PresenceInlineListItemView } from './presenceinlinelistitemview.js';
10
- import { type PresenceCounterView } from './presencecounterview.js';
11
- import { KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
6
+ * @module real-time-collaboration/presencelist/view/presenceinlinelistview
7
+ */
8
+ import { View, type FocusableView, type ViewCollection } from "@ckeditor/ckeditor5-ui";
9
+ import { type PresenceInlineListItemView } from "./presenceinlinelistitemview.js";
10
+ import { type PresenceCounterView } from "./presencecounterview.js";
11
+ import { KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
12
12
  export declare class PresenceInlineListView extends View implements FocusableView {
13
- /**
14
- * The collection of `PresenceInlineListItemView` instances.
15
- */
16
- readonly items: ViewCollection<PresenceInlineListItemView | PresenceCounterView>;
17
- /**
18
- * The keystroke handler for the presence inline list view.
19
- */
20
- readonly keystrokes: KeystrokeHandler;
21
- /**
22
- * Indicates whether the element has popup.
23
- */
24
- hasPopup: boolean;
25
- /**
26
- * Indicates whether the presence inline list view is expanded or not.
27
- */
28
- isExpanded: boolean;
29
- constructor(locale: Locale);
30
- /**
31
- * @inheritDoc
32
- */
33
- focus(): void;
34
- /**
35
- * @inheritDoc
36
- */
37
- render(): void;
13
+ /**
14
+ * The collection of `PresenceInlineListItemView` instances.
15
+ */
16
+ readonly items: ViewCollection<PresenceInlineListItemView | PresenceCounterView>;
17
+ /**
18
+ * The keystroke handler for the presence inline list view.
19
+ */
20
+ readonly keystrokes: KeystrokeHandler;
21
+ /**
22
+ * Indicates whether the element has popup.
23
+ */
24
+ hasPopup: boolean;
25
+ /**
26
+ * Indicates whether the presence inline list view is expanded or not.
27
+ */
28
+ isExpanded: boolean;
29
+ constructor(locale: Locale);
30
+ /**
31
+ * @inheritDoc
32
+ */
33
+ focus(): void;
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ override render(): void;
38
38
  }
@@ -1,5 +1,6 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
5
- import '../../../theme/presencelist.css';
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
+ import "../../../theme/presencelist.css";
6
+ export {};
@@ -1,37 +1,37 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/presencelist
7
- * @publicApi
8
- */
9
- import { ContextPlugin } from '@ckeditor/ckeditor5-core';
10
- import { Sessions } from './realtimecollaborativeediting/sessions.js';
11
- import { PresenceListUI } from './presencelist/presencelistui.js';
6
+ * @module real-time-collaboration/presencelist
7
+ * @publicApi
8
+ */
9
+ import { ContextPlugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
10
+ import { Sessions } from "./realtimecollaborativeediting/sessions.js";
11
+ import { PresenceListUI } from "./presencelist/presencelistui.js";
12
12
  /**
13
- * The `PresenceList` plugin provides a UI which displays all {@link module:collaboration-core/users~Users users} that are
14
- * currently connected to the edited document. The users are displayed as a row of avatars.
15
- * The information about the users is provided by
16
- * [CKEditor Cloud Services](https://ckeditor.com/docs/cs/latest/developer-resources/security/token-endpoint.html#user).
17
- *
18
- * The presence list UI collapses to a dropdown if six or more users are connected.
19
- */
13
+ * The `PresenceList` plugin provides a UI which displays all {@link module:collaboration-core/users~Users users} that are
14
+ * currently connected to the edited document. The users are displayed as a row of avatars.
15
+ * The information about the users is provided by
16
+ * [CKEditor Cloud Services](https://ckeditor.com/docs/cs/latest/developer-resources/security/token-endpoint.html#user).
17
+ *
18
+ * The presence list UI collapses to a dropdown if six or more users are connected.
19
+ */
20
20
  export declare class PresenceList extends ContextPlugin {
21
- /**
22
- * @inheritDoc
23
- */
24
- static get requires(): readonly [typeof Sessions, typeof PresenceListUI];
25
- /**
26
- * @inheritDoc
27
- */
28
- static get pluginName(): "PresenceList";
29
- /**
30
- * @inheritDoc
31
- */
32
- static get isOfficialPlugin(): true;
33
- /**
34
- * @inheritDoc
35
- */
36
- static get isPremiumPlugin(): true;
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ static get requires(): PluginDependenciesOf<[Sessions, PresenceListUI]>;
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ static get pluginName(): "PresenceList";
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ static override get isOfficialPlugin(): true;
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ static override get isPremiumPlugin(): true;
37
37
  }
@@ -1,61 +1,61 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/realtimecollaborativecomments/cloudservicescommentsadapter
7
- * @publicApi
8
- */
9
- import { Context, ContextPlugin, type Editor } from '@ckeditor/ckeditor5-core';
10
- import { Users } from '@ckeditor/ckeditor5-collaboration-core';
11
- import { CommentsService } from '@ckeditor/ckeditor-cloud-services-collaboration';
12
- import { CommentsRepository } from '@ckeditor/ckeditor5-comments';
13
- import { WebSocketGateway, type RtcReconnectContextPlugin } from '../realtimecollaborativeediting/websocketgateway.js';
14
- import { Sessions } from '../realtimecollaborativeediting/sessions.js';
6
+ * @module real-time-collaboration/realtimecollaborativecomments/cloudservicescommentsadapter
7
+ * @publicApi
8
+ */
9
+ import { Context, ContextPlugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
10
+ import { Users } from "@ckeditor/ckeditor5-collaboration-core";
11
+ import { CommentsService } from "@ckeditor/ckeditor-cloud-services-collaboration";
12
+ import { CommentsRepository } from "@ckeditor/ckeditor5-comments";
13
+ import { WebSocketGateway, type RtcReconnectContextPlugin } from "../realtimecollaborativeediting/websocketgateway.js";
14
+ import { Sessions } from "../realtimecollaborativeediting/sessions.js";
15
15
  /**
16
- * The Cloud Services Comments Adapter plugin.
17
- *
18
- * Visit the {@glink features/collaboration/context-and-collaboration-features Context and Collaboration Features} guide
19
- * to learn how to use it.
20
- */
16
+ * The Cloud Services Comments Adapter plugin.
17
+ *
18
+ * Visit the {@glink features/collaboration/context-and-collaboration-features Context and Collaboration Features} guide
19
+ * to learn how to use it.
20
+ */
21
21
  export declare class CloudServicesCommentsAdapter extends ContextPlugin implements RtcReconnectContextPlugin {
22
- static CommentsService: typeof CommentsService;
23
- /**
24
- * @inheritDoc
25
- */
26
- static get requires(): readonly [typeof WebSocketGateway, typeof CommentsRepository, typeof Sessions, typeof Users];
27
- /**
28
- * @inheritDoc
29
- */
30
- static get pluginName(): "CloudServicesCommentsAdapter";
31
- /**
32
- * @inheritDoc
33
- */
34
- static get isOfficialPlugin(): true;
35
- /**
36
- * @inheritDoc
37
- */
38
- static get isPremiumPlugin(): true;
39
- /**
40
- * @inheritDoc
41
- */
42
- constructor(context: Editor | Context);
43
- /**
44
- * @inheritDoc
45
- */
46
- init(): Promise<void>;
47
- /**
48
- * @inheritDoc
49
- */
50
- destroy(): void;
51
- /**
52
- * A method that will be executed when the `WebSocketGateway` will reconnect.
53
- */
54
- reconnect(): Promise<void>;
55
- /**
56
- * It connects a service for the given channel ID to the WebSocket and synchronizes local comments (`CommentsRepository`)
57
- * with remote comments (the `service.connect()`'s response).
58
- */
59
- private _connectService;
60
- private _fetchMissingUsersForThreads;
22
+ static CommentsService: typeof CommentsService;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get requires(): PluginDependenciesOf<[WebSocketGateway, CommentsRepository, Sessions, Users]>;
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ static get pluginName(): "CloudServicesCommentsAdapter";
31
+ /**
32
+ * @inheritDoc
33
+ */
34
+ static override get isOfficialPlugin(): true;
35
+ /**
36
+ * @inheritDoc
37
+ */
38
+ static override get isPremiumPlugin(): true;
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ constructor(context: Editor | Context);
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ init(): Promise<void>;
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ override destroy(): void;
51
+ /**
52
+ * A method that will be executed when the `WebSocketGateway` will reconnect.
53
+ */
54
+ reconnect(): Promise<void>;
55
+ /**
56
+ * It connects a service for the given channel ID to the WebSocket and synchronizes local comments (`CommentsRepository`)
57
+ * with remote comments (the `service.connect()`'s response).
58
+ */
59
+ private _connectService;
60
+ private _fetchMissingUsersForThreads;
61
61
  }
@@ -1,45 +1,45 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module real-time-collaboration/realtimecollaborativecomments
7
- * @publicApi
8
- */
9
- import { Plugin } from '@ckeditor/ckeditor5-core';
10
- import { CloudServicesCommentsAdapter } from './realtimecollaborativecomments/cloudservicescommentsadapter.js';
11
- import { RealTimeCollaborativeEditing } from './realtimecollaborativeediting.js';
12
- import { WebSocketGateway } from './realtimecollaborativeediting/websocketgateway.js';
13
- import { Comments } from '@ckeditor/ckeditor5-comments';
6
+ * @module real-time-collaboration/realtimecollaborativecomments
7
+ * @publicApi
8
+ */
9
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
10
+ import { CloudServicesCommentsAdapter } from "./realtimecollaborativecomments/cloudservicescommentsadapter.js";
11
+ import { RealTimeCollaborativeEditing } from "./realtimecollaborativeediting.js";
12
+ import { WebSocketGateway } from "./realtimecollaborativeediting/websocketgateway.js";
13
+ import { Comments } from "@ckeditor/ckeditor5-comments";
14
14
  /**
15
- * Enables the real-time collaborative comments feature.
16
- *
17
- * Check the {@glink features/collaboration/real-time-collaboration/real-time-collaboration-integration Real-time collaboration guide}
18
- * to see how to launch the editor in the real-time collaboration mode.
19
- */
15
+ * Enables the real-time collaborative comments feature.
16
+ *
17
+ * Check the {@glink features/collaboration/real-time-collaboration/real-time-collaboration-integration Real-time collaboration guide}
18
+ * to see how to launch the editor in the real-time collaboration mode.
19
+ */
20
20
  export declare class RealTimeCollaborativeComments extends Plugin {
21
- /**
22
- * @inheritDoc
23
- */
24
- static get requires(): readonly [typeof Comments, typeof CloudServicesCommentsAdapter, typeof RealTimeCollaborativeEditing, typeof WebSocketGateway];
25
- /**
26
- * @inheritDoc
27
- */
28
- static get pluginName(): "RealTimeCollaborativeComments";
29
- /**
30
- * @inheritDoc
31
- */
32
- static get isOfficialPlugin(): true;
33
- /**
34
- * @inheritDoc
35
- */
36
- static get isPremiumPlugin(): true;
37
- /**
38
- * @inheritDoc
39
- */
40
- init(): Promise<void>;
41
- /**
42
- * @inheritDoc
43
- */
44
- destroy(): void;
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ static get requires(): PluginDependenciesOf<[Comments, CloudServicesCommentsAdapter, RealTimeCollaborativeEditing, WebSocketGateway]>;
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ static get pluginName(): "RealTimeCollaborativeComments";
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ static override get isOfficialPlugin(): true;
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ static override get isPremiumPlugin(): true;
37
+ /**
38
+ * @inheritDoc
39
+ */
40
+ init(): Promise<void>;
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ override destroy(): void;
45
45
  }