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

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,71 +1,71 @@
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 type { RtcPresenceListConfig } from './config.js';
6
- import type { RealTimeCollaborativeEditing, RealTimeCollaborativeTrackChanges, RealTimeCollaborativeComments, RealTimeCollaborativeRevisionHistory, CloudServicesCommentsAdapter, CloudServicesTrackChangesAdapter, CloudServicesRevisionHistoryAdapter, RealTimeCollaborationClient } from './index.js';
7
- declare module '@ckeditor/ckeditor5-core' {
8
- interface EditorConfig {
9
- presenceList?: RtcPresenceListConfig;
10
- }
11
- interface PluginsMap {
12
- [RealTimeCollaborativeEditing.pluginName]: RealTimeCollaborativeEditing;
13
- [RealTimeCollaborativeTrackChanges.pluginName]: RealTimeCollaborativeTrackChanges;
14
- [RealTimeCollaborativeComments.pluginName]: RealTimeCollaborativeComments;
15
- [RealTimeCollaborativeRevisionHistory.pluginName]: RealTimeCollaborativeRevisionHistory;
16
- [CloudServicesCommentsAdapter.pluginName]: CloudServicesCommentsAdapter;
17
- [CloudServicesTrackChangesAdapter.pluginName]: CloudServicesTrackChangesAdapter;
18
- [CloudServicesRevisionHistoryAdapter.pluginName]: CloudServicesRevisionHistoryAdapter;
19
- [RealTimeCollaborationClient.pluginName]: RealTimeCollaborationClient;
20
- }
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 type { RtcPresenceListConfig } from "./config.js";
6
+ import type { RealTimeCollaborativeEditing, RealTimeCollaborativeTrackChanges, RealTimeCollaborativeComments, RealTimeCollaborativeRevisionHistory, CloudServicesCommentsAdapter, CloudServicesTrackChangesAdapter, CloudServicesRevisionHistoryAdapter, RealTimeCollaborationClient } from "./index.js";
7
+ declare module "@ckeditor/ckeditor5-core" {
8
+ interface EditorConfig {
9
+ presenceList?: RtcPresenceListConfig;
10
+ }
11
+ interface PluginsMap {
12
+ [RealTimeCollaborativeEditing.pluginName]: RealTimeCollaborativeEditing;
13
+ [RealTimeCollaborativeTrackChanges.pluginName]: RealTimeCollaborativeTrackChanges;
14
+ [RealTimeCollaborativeComments.pluginName]: RealTimeCollaborativeComments;
15
+ [RealTimeCollaborativeRevisionHistory.pluginName]: RealTimeCollaborativeRevisionHistory;
16
+ [CloudServicesCommentsAdapter.pluginName]: CloudServicesCommentsAdapter;
17
+ [CloudServicesTrackChangesAdapter.pluginName]: CloudServicesTrackChangesAdapter;
18
+ [CloudServicesRevisionHistoryAdapter.pluginName]: CloudServicesRevisionHistoryAdapter;
19
+ [RealTimeCollaborationClient.pluginName]: RealTimeCollaborationClient;
20
+ }
21
21
  }
22
- declare module '@ckeditor/ckeditor5-cloud-services' {
23
- interface CloudServicesConfig {
24
- /**
25
- * The timeout (in seconds) for the connection. Defaults to 10.
26
- *
27
- * If the connection will not be established after the specified number of second passes, the editor will throw an error.
28
- *
29
- * Raise this value if you are experiencing connection timeout problems.
30
- *
31
- * ```ts
32
- * ClassicEditor
33
- * .create( {
34
- * cloudServices: {
35
- * connectionTimeout: 20,
36
- * // ...
37
- * }
38
- * } )
39
- * .then( ... )
40
- * .catch( ... );
41
- * ```
42
- */
43
- connectionTimeout?: number;
44
- /**
45
- * The timeout (in seconds) for each request send to the Cloud Services. Defaults to 20.
46
- *
47
- * If the request is not finished after the specified number of second passes, the editor will throw an error.
48
- *
49
- * Raise this value if you expect that your requests will be big
50
- * (e.g. mostly concerns the document data and the initial request).
51
- *
52
- * ```ts
53
- * ClassicEditor
54
- * .create( {
55
- * cloudServices: {
56
- * requestTimeout: 40,
57
- * // ...
58
- * }
59
- * } )
60
- * .then( ... )
61
- * .catch( ... );
62
- * ```
63
- */
64
- requestTimeout?: number;
65
- }
22
+ declare module "@ckeditor/ckeditor5-cloud-services" {
23
+ interface CloudServicesConfig {
24
+ /**
25
+ * The timeout (in seconds) for the connection. Defaults to 10.
26
+ *
27
+ * If the connection will not be established after the specified number of second passes, the editor will throw an error.
28
+ *
29
+ * Raise this value if you are experiencing connection timeout problems.
30
+ *
31
+ * ```ts
32
+ * ClassicEditor
33
+ * .create( {
34
+ * cloudServices: {
35
+ * connectionTimeout: 20,
36
+ * // ...
37
+ * }
38
+ * } )
39
+ * .then( ... )
40
+ * .catch( ... );
41
+ * ```
42
+ */
43
+ connectionTimeout?: number;
44
+ /**
45
+ * The timeout (in seconds) for each request send to the Cloud Services. Defaults to 20.
46
+ *
47
+ * If the request is not finished after the specified number of second passes, the editor will throw an error.
48
+ *
49
+ * Raise this value if you expect that your requests will be big
50
+ * (e.g. mostly concerns the document data and the initial request).
51
+ *
52
+ * ```ts
53
+ * ClassicEditor
54
+ * .create( {
55
+ * cloudServices: {
56
+ * requestTimeout: 40,
57
+ * // ...
58
+ * }
59
+ * } )
60
+ * .then( ... )
61
+ * .catch( ... );
62
+ * ```
63
+ */
64
+ requestTimeout?: number;
65
+ }
66
66
  }
67
- declare module '@ckeditor/ckeditor5-collaboration-core' {
68
- interface User {
69
- orderNumber?: number;
70
- }
67
+ declare module "@ckeditor/ckeditor5-collaboration-core" {
68
+ interface User {
69
+ orderNumber?: number;
70
+ }
71
71
  }
@@ -1,9 +1,9 @@
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/common-translations
7
- */
8
- import type { Locale } from '@ckeditor/ckeditor5-utils';
6
+ * @module real-time-collaboration/common-translations
7
+ */
8
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
9
9
  export declare function getTranslation(locale: Locale, id: string, values?: Array<string> | number): string;
package/dist/config.d.ts CHANGED
@@ -1,48 +1,48 @@
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/config
7
- * @publicApi
8
- */
9
- import type { User } from '@ckeditor/ckeditor5-collaboration-core';
6
+ * @module real-time-collaboration/config
7
+ * @publicApi
8
+ */
9
+ import type { User } from "@ckeditor/ckeditor5-collaboration-core";
10
10
  /**
11
- * The configuration of the real-time collaboration features.
12
- *
13
- * ```ts
14
- * ClassicEditor
15
- * .create( {
16
- * presenceList: ... // Collaboration presence list configuration.
17
- * } )
18
- * .then( ... )
19
- * .catch( ... );
20
- * ```
21
- *
22
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
23
- */
11
+ * The configuration of the real-time collaboration features.
12
+ *
13
+ * ```ts
14
+ * ClassicEditor
15
+ * .create( {
16
+ * presenceList: ... // Collaboration presence list configuration.
17
+ * } )
18
+ * .then( ... )
19
+ * .catch( ... );
20
+ * ```
21
+ *
22
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
23
+ */
24
24
  export interface RtcPresenceListConfig {
25
- /**
26
- * Indicates a number of displayed users at which the presence list will switch to a dropdown view.
27
- * If the number is 8, then 7 users will still be displayed inline, while 8+ users will be displayed in the dropdown.
28
- *
29
- * The number must be greater than `0`.
30
- *
31
- * @default 6
32
- */
33
- collapseAt?: number;
34
- /**
35
- * DOM element that will hold the feature’s UI.
36
- */
37
- container?: HTMLElement;
38
- /**
39
- * Determines if the local user avatar should be displayed in the presence list (`true`) or not (`false`).
40
- *
41
- * @default true
42
- */
43
- displayMe?: boolean;
44
- /**
45
- * Callback function that will be invoked after a click on a presence list member.
46
- */
47
- onClick?: (user: User, element: HTMLElement) => void;
25
+ /**
26
+ * Indicates a number of displayed users at which the presence list will switch to a dropdown view.
27
+ * If the number is 8, then 7 users will still be displayed inline, while 8+ users will be displayed in the dropdown.
28
+ *
29
+ * The number must be greater than `0`.
30
+ *
31
+ * @default 6
32
+ */
33
+ collapseAt?: number;
34
+ /**
35
+ * DOM element that will hold the feature’s UI.
36
+ */
37
+ container?: HTMLElement;
38
+ /**
39
+ * Determines if the local user avatar should be displayed in the presence list (`true`) or not (`false`).
40
+ *
41
+ * @default true
42
+ */
43
+ displayMe?: boolean;
44
+ /**
45
+ * Callback function that will be invoked after a click on a presence list member.
46
+ */
47
+ onClick?: (user: User, element: HTMLElement) => void;
48
48
  }
package/dist/index.d.ts CHANGED
@@ -1,21 +1,21 @@
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
7
- */
8
- export { RealTimeCollaborativeEditing } from './realtimecollaborativeediting.js';
9
- export { RealTimeCollaborativeTrackChanges } from './realtimecollaborativetrackchanges.js';
10
- export { RealTimeCollaborativeComments } from './realtimecollaborativecomments.js';
11
- export { RealTimeCollaborativeRevisionHistory } from './realtimecollaborativerevisionhistory.js';
12
- export { CloudServicesCommentsAdapter } from './realtimecollaborativecomments/cloudservicescommentsadapter.js';
13
- export { CloudServicesTrackChangesAdapter } from './realtimecollaborativetrackchanges/cloudservicestrackchangesadapter.js';
14
- export { CloudServicesRevisionHistoryAdapter } from './realtimecollaborativerevisionhistory/cloudservicesrevisionhistoryadapter.js';
15
- export { RealTimeCollaborationClient } from './realtimecollaborativeediting/realtimecollaborationclient.js';
16
- export { PresenceListUI } from './presencelist/presencelistui.js';
17
- export { PresenceList } from './presencelist.js';
18
- export { Sessions, type RtcServerUser, type RtcSessionAddEvent } from './realtimecollaborativeediting/sessions.js';
19
- export { WebSocketGateway, type RtcReconnect, type RtcReconnectPlugin, type RtcReconnectContextPlugin } from './realtimecollaborativeediting/websocketgateway.js';
20
- export type { RtcPresenceListConfig } from './config.js';
21
- import './augmentation.js';
6
+ * @module real-time-collaboration
7
+ */
8
+ export { RealTimeCollaborativeEditing } from "./realtimecollaborativeediting.js";
9
+ export { RealTimeCollaborativeTrackChanges } from "./realtimecollaborativetrackchanges.js";
10
+ export { RealTimeCollaborativeComments } from "./realtimecollaborativecomments.js";
11
+ export { RealTimeCollaborativeRevisionHistory } from "./realtimecollaborativerevisionhistory.js";
12
+ export { CloudServicesCommentsAdapter } from "./realtimecollaborativecomments/cloudservicescommentsadapter.js";
13
+ export { CloudServicesTrackChangesAdapter } from "./realtimecollaborativetrackchanges/cloudservicestrackchangesadapter.js";
14
+ export { CloudServicesRevisionHistoryAdapter } from "./realtimecollaborativerevisionhistory/cloudservicesrevisionhistoryadapter.js";
15
+ export { RealTimeCollaborationClient } from "./realtimecollaborativeediting/realtimecollaborationclient.js";
16
+ export { PresenceListUI } from "./presencelist/presencelistui.js";
17
+ export { PresenceList } from "./presencelist.js";
18
+ export { Sessions, type RtcServerUser, type RtcSessionAddEvent } from "./realtimecollaborativeediting/sessions.js";
19
+ export { WebSocketGateway, type RtcReconnect, type RtcReconnectPlugin, type RtcReconnectContextPlugin } from "./realtimecollaborativeediting/websocketgateway.js";
20
+ export type { RtcPresenceListConfig } from "./config.js";
21
+ import "./augmentation.js";