@ckeditor/ckeditor5-revision-history 0.0.0-nightly-20241216.0 → 0.0.0-nightly-20241218.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 (213) hide show
  1. package/build/revision-history.js +1 -1
  2. package/dist/index-editor.css +1 -0
  3. package/dist/index.css +2 -0
  4. package/dist/index.js +5 -7
  5. package/dist/translations/af.js +1 -1
  6. package/dist/translations/af.umd.js +1 -1
  7. package/dist/translations/ar.js +1 -1
  8. package/dist/translations/ar.umd.js +1 -1
  9. package/dist/translations/ast.js +1 -1
  10. package/dist/translations/ast.umd.js +1 -1
  11. package/dist/translations/az.js +1 -1
  12. package/dist/translations/az.umd.js +1 -1
  13. package/dist/translations/bg.js +1 -1
  14. package/dist/translations/bg.umd.js +1 -1
  15. package/dist/translations/bn.js +1 -1
  16. package/dist/translations/bn.umd.js +1 -1
  17. package/dist/translations/bs.js +1 -1
  18. package/dist/translations/bs.umd.js +1 -1
  19. package/dist/translations/ca.js +1 -1
  20. package/dist/translations/ca.umd.js +1 -1
  21. package/dist/translations/cs.js +1 -1
  22. package/dist/translations/cs.umd.js +1 -1
  23. package/dist/translations/da.js +1 -1
  24. package/dist/translations/da.umd.js +1 -1
  25. package/dist/translations/de-ch.js +1 -1
  26. package/dist/translations/de-ch.umd.js +1 -1
  27. package/dist/translations/de.js +1 -1
  28. package/dist/translations/de.umd.js +1 -1
  29. package/dist/translations/el.js +1 -1
  30. package/dist/translations/el.umd.js +1 -1
  31. package/dist/translations/en-au.js +1 -1
  32. package/dist/translations/en-au.umd.js +1 -1
  33. package/dist/translations/en-gb.js +1 -1
  34. package/dist/translations/en-gb.umd.js +1 -1
  35. package/dist/translations/en.js +1 -1
  36. package/dist/translations/en.umd.js +1 -1
  37. package/dist/translations/eo.js +1 -1
  38. package/dist/translations/eo.umd.js +1 -1
  39. package/dist/translations/es-co.js +1 -1
  40. package/dist/translations/es-co.umd.js +1 -1
  41. package/dist/translations/es.js +1 -1
  42. package/dist/translations/es.umd.js +1 -1
  43. package/dist/translations/et.js +1 -1
  44. package/dist/translations/et.umd.js +1 -1
  45. package/dist/translations/eu.js +1 -1
  46. package/dist/translations/eu.umd.js +1 -1
  47. package/dist/translations/fa.js +1 -1
  48. package/dist/translations/fa.umd.js +1 -1
  49. package/dist/translations/fi.js +1 -1
  50. package/dist/translations/fi.umd.js +1 -1
  51. package/dist/translations/fr.js +1 -1
  52. package/dist/translations/fr.umd.js +1 -1
  53. package/dist/translations/gl.js +1 -1
  54. package/dist/translations/gl.umd.js +1 -1
  55. package/dist/translations/gu.js +1 -1
  56. package/dist/translations/gu.umd.js +1 -1
  57. package/dist/translations/he.js +1 -1
  58. package/dist/translations/he.umd.js +1 -1
  59. package/dist/translations/hi.js +1 -1
  60. package/dist/translations/hi.umd.js +1 -1
  61. package/dist/translations/hr.js +1 -1
  62. package/dist/translations/hr.umd.js +1 -1
  63. package/dist/translations/hu.js +1 -1
  64. package/dist/translations/hu.umd.js +1 -1
  65. package/dist/translations/hy.js +1 -1
  66. package/dist/translations/hy.umd.js +1 -1
  67. package/dist/translations/id.js +1 -1
  68. package/dist/translations/id.umd.js +1 -1
  69. package/dist/translations/it.js +1 -1
  70. package/dist/translations/it.umd.js +1 -1
  71. package/dist/translations/ja.js +1 -1
  72. package/dist/translations/ja.umd.js +1 -1
  73. package/dist/translations/jv.js +1 -1
  74. package/dist/translations/jv.umd.js +1 -1
  75. package/dist/translations/kk.js +1 -1
  76. package/dist/translations/kk.umd.js +1 -1
  77. package/dist/translations/km.js +1 -1
  78. package/dist/translations/km.umd.js +1 -1
  79. package/dist/translations/kn.js +1 -1
  80. package/dist/translations/kn.umd.js +1 -1
  81. package/dist/translations/ko.js +1 -1
  82. package/dist/translations/ko.umd.js +1 -1
  83. package/dist/translations/ku.js +1 -1
  84. package/dist/translations/ku.umd.js +1 -1
  85. package/dist/translations/lt.js +1 -1
  86. package/dist/translations/lt.umd.js +1 -1
  87. package/dist/translations/lv.js +1 -1
  88. package/dist/translations/lv.umd.js +1 -1
  89. package/dist/translations/ms.js +1 -1
  90. package/dist/translations/ms.umd.js +1 -1
  91. package/dist/translations/nb.js +1 -1
  92. package/dist/translations/nb.umd.js +1 -1
  93. package/dist/translations/ne.js +1 -1
  94. package/dist/translations/ne.umd.js +1 -1
  95. package/dist/translations/nl.js +1 -1
  96. package/dist/translations/nl.umd.js +1 -1
  97. package/dist/translations/no.js +1 -1
  98. package/dist/translations/no.umd.js +1 -1
  99. package/dist/translations/oc.js +1 -1
  100. package/dist/translations/oc.umd.js +1 -1
  101. package/dist/translations/pl.js +1 -1
  102. package/dist/translations/pl.umd.js +1 -1
  103. package/dist/translations/pt-br.js +1 -1
  104. package/dist/translations/pt-br.umd.js +1 -1
  105. package/dist/translations/pt.js +1 -1
  106. package/dist/translations/pt.umd.js +1 -1
  107. package/dist/translations/ro.js +1 -1
  108. package/dist/translations/ro.umd.js +1 -1
  109. package/dist/translations/ru.js +1 -1
  110. package/dist/translations/ru.umd.js +1 -1
  111. package/dist/translations/si.js +1 -1
  112. package/dist/translations/si.umd.js +1 -1
  113. package/dist/translations/sk.js +1 -1
  114. package/dist/translations/sk.umd.js +1 -1
  115. package/dist/translations/sl.js +1 -1
  116. package/dist/translations/sl.umd.js +1 -1
  117. package/dist/translations/sq.js +1 -1
  118. package/dist/translations/sq.umd.js +1 -1
  119. package/dist/translations/sr-latn.js +1 -1
  120. package/dist/translations/sr-latn.umd.js +1 -1
  121. package/dist/translations/sr.js +1 -1
  122. package/dist/translations/sr.umd.js +1 -1
  123. package/dist/translations/sv.js +1 -1
  124. package/dist/translations/sv.umd.js +1 -1
  125. package/dist/translations/th.js +1 -1
  126. package/dist/translations/th.umd.js +1 -1
  127. package/dist/translations/ti.js +1 -1
  128. package/dist/translations/ti.umd.js +1 -1
  129. package/dist/translations/tk.js +1 -1
  130. package/dist/translations/tk.umd.js +1 -1
  131. package/dist/translations/tr.js +1 -1
  132. package/dist/translations/tr.umd.js +1 -1
  133. package/dist/translations/tt.js +1 -1
  134. package/dist/translations/tt.umd.js +1 -1
  135. package/dist/translations/ug.js +1 -1
  136. package/dist/translations/ug.umd.js +1 -1
  137. package/dist/translations/uk.js +1 -1
  138. package/dist/translations/uk.umd.js +1 -1
  139. package/dist/translations/ur.js +1 -1
  140. package/dist/translations/ur.umd.js +1 -1
  141. package/dist/translations/uz.js +1 -1
  142. package/dist/translations/uz.umd.js +1 -1
  143. package/dist/translations/vi.js +1 -1
  144. package/dist/translations/vi.umd.js +1 -1
  145. package/dist/translations/zh-cn.js +1 -1
  146. package/dist/translations/zh-cn.umd.js +1 -1
  147. package/dist/translations/zh.js +1 -1
  148. package/dist/translations/zh.umd.js +1 -1
  149. package/package.json +27 -8
  150. package/src/changeitem.js +2 -2
  151. package/src/editor/revisionviewereditor.js +2 -2
  152. package/src/editor/revisionviewereditorui.js +1 -1
  153. package/src/editor/revisionviewereditoruiview.js +1 -1
  154. package/src/index.js +1 -1
  155. package/src/revision.js +2 -2
  156. package/src/revisiondiff.js +1 -1
  157. package/src/revisionhistory.js +1 -1
  158. package/src/revisionsrepository.js +1 -1
  159. package/src/revisiontracker.js +1 -1
  160. package/src/revisionviewer.js +1 -1
  161. package/src/ui/revision/createrevisionactionsdropdown.js +1 -1
  162. package/src/ui/revision/revisionauthorview.js +1 -1
  163. package/src/ui/revision/revisionnameview.js +1 -1
  164. package/src/ui/revision/revisionview.js +2 -2
  165. package/src/ui/revision/subrevisioncollapserview.js +1 -1
  166. package/src/ui/revision/subrevisionview.js +1 -1
  167. package/src/ui/revision/utils.js +1 -1
  168. package/src/ui/revisionhistory/revisionhistorysaverevisionformview.js +1 -1
  169. package/src/ui/revisionhistory/revisionhistoryui.js +1 -1
  170. package/src/ui/revisionssidebar/revisionssidebar.js +1 -1
  171. package/src/ui/revisionssidebar/revisionssidebarheaderview.js +1 -1
  172. package/src/ui/revisionssidebar/revisionssidebartimeperiodview.js +1 -1
  173. package/src/ui/revisionssidebar/revisionssidebarview.js +1 -1
  174. package/src/ui/revisionssidebar/utils.js +1 -1
  175. package/src/ui/revisionviewer/changedetailsview.js +1 -1
  176. package/src/ui/revisionviewer/changesnavigationview.js +1 -1
  177. package/src/ui/revisionviewer/revisionviewerloadingoverlay.js +1 -1
  178. package/src/ui/revisionviewer/revisionviewerui.js +1 -1
  179. package/src/utils/common-translations.js +1 -1
  180. package/theme/revisionviewerloadingoverlay.css +2 -0
  181. package/dist/augmentation.d.ts +0 -33
  182. package/dist/changeitem.d.ts +0 -62
  183. package/dist/editor/revisionviewereditor.d.ts +0 -31
  184. package/dist/editor/revisionviewereditorui.d.ts +0 -32
  185. package/dist/editor/revisionviewereditoruiview.d.ts +0 -47
  186. package/dist/index.d.ts +0 -20
  187. package/dist/revision.d.ts +0 -157
  188. package/dist/revisiondiff.d.ts +0 -28
  189. package/dist/revisionhistory.d.ts +0 -111
  190. package/dist/revisionhistoryadapter.d.ts +0 -68
  191. package/dist/revisionhistoryconfig.d.ts +0 -75
  192. package/dist/revisionsrepository.d.ts +0 -64
  193. package/dist/revisiontracker.d.ts +0 -141
  194. package/dist/revisionviewer.d.ts +0 -119
  195. package/dist/ui/revision/createrevisionactionsdropdown.d.ts +0 -17
  196. package/dist/ui/revision/revisionauthorview.d.ts +0 -18
  197. package/dist/ui/revision/revisionnameview.d.ts +0 -34
  198. package/dist/ui/revision/revisionview.d.ts +0 -99
  199. package/dist/ui/revision/subrevisioncollapserview.d.ts +0 -25
  200. package/dist/ui/revision/subrevisionview.d.ts +0 -38
  201. package/dist/ui/revision/utils.d.ts +0 -9
  202. package/dist/ui/revisionhistory/revisionhistorysaverevisionformview.d.ts +0 -61
  203. package/dist/ui/revisionhistory/revisionhistoryui.d.ts +0 -38
  204. package/dist/ui/revisionssidebar/revisionssidebar.d.ts +0 -56
  205. package/dist/ui/revisionssidebar/revisionssidebarheaderview.d.ts +0 -20
  206. package/dist/ui/revisionssidebar/revisionssidebartimeperiodview.d.ts +0 -33
  207. package/dist/ui/revisionssidebar/revisionssidebarview.d.ts +0 -48
  208. package/dist/ui/revisionssidebar/utils.d.ts +0 -13
  209. package/dist/ui/revisionviewer/changedetailsview.d.ts +0 -26
  210. package/dist/ui/revisionviewer/changesnavigationview.d.ts +0 -44
  211. package/dist/ui/revisionviewer/revisionviewerloadingoverlay.d.ts +0 -38
  212. package/dist/ui/revisionviewer/revisionviewerui.d.ts +0 -40
  213. package/dist/utils/common-translations.d.ts +0 -15
@@ -1,141 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/revisiontracker
11
- * @publicApi
12
- */
13
- import { Users, type CollaborationHistory } from 'ckeditor5-collaboration/src/collaboration-core.js';
14
- import { Plugin, PendingActions, type Editor } from 'ckeditor5/src/core.js';
15
- import RevisionsRepository from './revisionsrepository.js';
16
- import type { RevisionHistoryAdapter } from './revisionhistoryadapter.js';
17
- import type { default as Revision, RevisionData } from './revision.js';
18
- /**
19
- * Creates and updates revisions based on changes of the editor content.
20
- *
21
- * There are always at least two revisions available for the document: the initial revision and the current revision.
22
- * If those revisions have not been created for the document yet, they are created when the editor data is loaded.
23
- *
24
- * The initial revision contains the initial document data from when the document was loaded for the first time.
25
- *
26
- * The current revision contains all the unsaved document changes, that is changes which have not been saved yet as a specific revision.
27
- * The current revision is always available and it is always the "top" revision (most recent).
28
- */
29
- export default class RevisionTracker extends Plugin {
30
- /**
31
- * An adapter object that should communicate with the data source to fetch or save the revisions data.
32
- *
33
- * This property is also set through {@link module:revision-history/revisionhistory~RevisionHistory#adapter}.
34
- */
35
- adapter: RevisionHistoryAdapter | null;
36
- repository?: RevisionsRepository;
37
- static get pluginName(): "RevisionTracker";
38
- /**
39
- * @inheritDoc
40
- */
41
- static get isOfficialPlugin(): true;
42
- /**
43
- * @inheritDoc
44
- */
45
- static get isPremiumPlugin(): true;
46
- static get requires(): readonly [typeof Users, typeof RevisionsRepository, typeof PendingActions];
47
- constructor(editor: Editor);
48
- /**
49
- * @inheritDoc
50
- */
51
- init(): void;
52
- afterInit(): Promise<void>;
53
- /**
54
- * @inheritDoc
55
- */
56
- destroy(): void;
57
- /**
58
- * Adds the new document changes to the current revision.
59
- *
60
- * This method should be called before document data and revision data is saved (for example, in the autosave callback).
61
- *
62
- * @returns Promise that is resolved after the revision is updated locally (the promise does not wait for the adapter update).
63
- */
64
- update(): Promise<void>;
65
- private _loadState;
66
- /**
67
- * Creates and saves a new revision.
68
- *
69
- * ```ts
70
- * // Saves all the unsaved changes as a revision without a name.
71
- * const myRevision = await revisionTracker.saveRevision();
72
- *
73
- * // Saves all the unsaved changes as a revision named 'My revision'.
74
- * const myRevision = await revisionTracker.saveRevision( { name: 'My revision' } );
75
- *
76
- * // Saves a revision named 'My revision'.
77
- * // It will include document data with all the changes up to document version `30`.
78
- * // The revision will be on "top" of the closest revision with a lower document version.
79
- * // The revision diff will include all the changes since the previous revision up to document version `30`.
80
- * const myRevision = await revisionTracker.saveRevision( { name: 'My revision' }, 30 );
81
- * ```
82
- *
83
- * A new revision can be created in the middle of the revision history. In such case, already existing revisions will be
84
- * appropriately updated.
85
- *
86
- * Using this method, a revision without a name can be created even if the
87
- * {@link module:revision-history/revisionhistoryconfig~RevisionHistoryConfig#requireRevisionName `requireRevisionName` }
88
- * configuration option is set to `true`.
89
- *
90
- * @param revisionData Revision data to set on the created revision.
91
- * @param version {@link module:engine/model/document~Document#version Document version} on which the revision is saved.
92
- * If not set, the revision will be saved for the current (most recent) document state.
93
- * @returns Promise that resolves with the created revision after it is saved locally (the promise does not wait for the
94
- * adapter update).
95
- */
96
- saveRevision(revisionData?: RevisionData, version?: number | null): Promise<Revision>;
97
- /**
98
- * Creates a revision basing on given revision data and adds it to the revision tracker and revision repository.
99
- */
100
- addRevisionData(revisionData: RevisionData): Revision;
101
- /**
102
- * Returns document data for given revision.
103
- *
104
- * The document data is HTML or other format, depending on the editor configuration.
105
- *
106
- * This method returns a promise which resolves with an object, where keys are root names and values are these roots' data. Most
107
- * editor setups use just one root, which has the default name `main`. In this case, the promise will resolve with an object
108
- * similar to this:
109
- *
110
- * ```ts
111
- * { main: "<p>Sample document data.</p>" }
112
- * ```
113
- *
114
- * Please note, that the data returned by this method uses
115
- * {@link module:engine/dataprocessor/dataprocessor~DataProcessor#useFillerType marked fillers mode}. This means that some `&nbsp;`
116
- * characters in the returned data may be wrapped with `<span data-cke-filler="true">&nbsp;</span>`. Take this difference into
117
- * consideration if you plan to compare revision data with the data returned by `editor.getData()`.
118
- *
119
- * See also {@link module:revision-history/revisiontracker~RevisionTracker#getRevisionRootsAttributes}.
120
- */
121
- getRevisionDocumentData(revision: Revision): Promise<Record<string, string>>;
122
- /**
123
- * Returns roots attributes for given revision.
124
- *
125
- * This method returns a promise which resolves with an object, where keys are root names and values are these roots' attributes.
126
- * Most editor setups use just one root, which has the default name `main`. In this case, the promise will resolve with an object
127
- * similar to this:
128
- *
129
- * ```ts
130
- * { main: {} }
131
- * ```
132
- *
133
- * See also {@link module:revision-history/revisiontracker~RevisionTracker#getRevisionDocumentData}.
134
- */
135
- getRevisionRootsAttributes(revision: Revision): Promise<Record<string, Record<string, unknown>>>;
136
- }
137
- export interface RevisionSource {
138
- history: CollaborationHistory;
139
- getLatestVersion: () => Promise<number>;
140
- getCurrentRevisionId: () => string;
141
- }
@@ -1,119 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/revisionviewer
11
- */
12
- import { Plugin, Command, type Editor } from 'ckeditor5/src/core.js';
13
- import { ContextualBalloon } from 'ckeditor5/src/ui.js';
14
- import { Users } from 'ckeditor5-collaboration/src/collaboration-core.js';
15
- import ChangeDetailsView from './ui/revisionviewer/changedetailsview.js';
16
- import RevisionsRepository from './revisionsrepository.js';
17
- import ChangeItem from './changeitem.js';
18
- import { default as RevisionDiff } from './revisiondiff.js';
19
- import '../theme/revisionviewer.css';
20
- import type { RevisionHistoryAdapter } from './revisionhistoryadapter.js';
21
- import type { default as Revision, RevisionJSON } from './revision.js';
22
- export default class RevisionViewer extends Plugin {
23
- repository: RevisionsRepository;
24
- adapter: RevisionHistoryAdapter | null;
25
- /**
26
- * @observable
27
- */
28
- activeChange: ChangeItem | null;
29
- /**
30
- * @observable
31
- */
32
- activeView: ChangeDetailsView | null;
33
- /**
34
- * @observable
35
- */
36
- diff: RevisionDiff | null;
37
- /**
38
- * @observable
39
- */
40
- isReady: boolean;
41
- /**
42
- * @observable
43
- */
44
- isEnabled: boolean;
45
- /**
46
- * @observable
47
- */
48
- isNavigationMode: boolean;
49
- /**
50
- * @observable
51
- */
52
- currentChangeNumber: number;
53
- /**
54
- * @observable
55
- */
56
- numberOfChanges: number;
57
- static get pluginName(): "RevisionViewer";
58
- /**
59
- * @inheritDoc
60
- */
61
- static get isOfficialPlugin(): true;
62
- /**
63
- * @inheritDoc
64
- */
65
- static get isPremiumPlugin(): true;
66
- static get requires(): readonly [typeof Users, typeof ContextualBalloon, typeof RevisionsRepository];
67
- constructor(editor: Editor);
68
- init(): void;
69
- getRevisionData(revision: Revision): Promise<Record<string, string>>;
70
- getRevisionRootsAttributes(revision: Revision): Promise<Record<string, Record<string, unknown>>>;
71
- compare(newRevisionOrId: Revision | string, oldRevisionOrId: Revision | string, forceCompare?: boolean): Promise<unknown>;
72
- addRevisionData(revisionData: RevisionJSON, updateCallback: (updateObj: RevisionJSON, isFromAdapter: boolean, revision: Revision) => void): Revision;
73
- loadRevisionData(revision: Revision): Promise<any>;
74
- private _removeMissingPairs;
75
- }
76
- export declare class RestoreRevisionCommand extends Command {
77
- constructor(editor: Editor);
78
- execute(): void;
79
- refresh(): void;
80
- }
81
- export declare class ShowChangeCommand<T extends 'backward' | 'forward'> extends Command {
82
- constructor(editor: Editor, { direction }: {
83
- direction: T;
84
- });
85
- /**
86
- * TODO
87
- */
88
- execute(): void;
89
- /**
90
- * TODO
91
- *
92
- * The `showNextChange` command is enabled if the revision viewer is ready and either the navigation
93
- * mode is off, or there is any "next" change to select within current revision.
94
- *
95
- * The `showPreviousChange` command is enabled if the revision viewer is ready and either the navigation
96
- * mode is off, or there is any "previous" change to select within current revision.
97
- */
98
- refresh(): void;
99
- }
100
- /**
101
- function printTape( tape ) {
102
- const elements = tape.map(
103
- item => item.item.data ? item.item.data : item.type == 'elementStart' ? '<' + item.item.name + '>' : '</' + item.item.name + '>'
104
- ).join( '' );
105
-
106
- const signs = tape.map( v => {
107
- const item = v.item;
108
- const sign = ( v.isAdded || v.isAddSuggestion ) ? v.isRemoved ? '=' : '+' : v.isRemoved ? '-' : ' ';
109
- const len = item.data ? item.data.length : v.type == 'elementStart' ? item.name.length + 2 : item.name.length + 3;
110
-
111
- return sign.repeat( len );
112
- } ).join( '' );
113
-
114
- console.log( elements );
115
- console.log( signs );
116
- }
117
-
118
- window.printTape = printTape;
119
- /**/
@@ -1,17 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- import { ViewModel, type DropdownView } from 'ckeditor5/src/ui.js';
10
- import '../../../theme/revision/revisionactions.css';
11
- import type RevisionView from './revisionview.js';
12
- import type { RevisionAction } from '../revisionssidebar/revisionssidebar.js';
13
- export declare function createActionsDropdownView(revisionView: RevisionView, revisionActions: Array<RevisionAction>): DropdownView;
14
- export interface RevisionDropdownOptions {
15
- type: 'button';
16
- model: ViewModel;
17
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revision/revisionauthorview
11
- */
12
- import { View } from 'ckeditor5/src/ui.js';
13
- import type { Locale } from 'ckeditor5/src/utils.js';
14
- import type { User } from 'ckeditor5-collaboration/src/collaboration-core.js';
15
- import '../../../theme/revision/revisionauthor.css';
16
- export default class RevisionAuthorView extends View {
17
- constructor(locale: Locale, author: User, isCreator: boolean);
18
- }
@@ -1,34 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revision/revisionnameview
11
- */
12
- import { LabeledFieldView, type InputTextView } from 'ckeditor5/src/ui.js';
13
- import { type Locale } from 'ckeditor5/src/utils.js';
14
- import '../../../theme/revision/revisionname.css';
15
- export default class RevisionNameView extends LabeledFieldView<InputTextView> {
16
- /**
17
- * @inheritDoc
18
- */
19
- constructor(locale: Locale, viewCreator: (labeledFieldView: LabeledFieldView, viewUid: string, statusUid: string) => InputTextView);
20
- /**
21
- * Renders the view and creates binding for tooltip. It's only displayed if the revision name is longer
22
- * than the container. There are two different scenarios this may happen:
23
- *
24
- * * while resizing the container,
25
- * * while changing the revision name.
26
- *
27
- * Hence, two different bindings are created: one using the `ResizeObserver` and the other using the input `value` property.
28
- */
29
- render(): void;
30
- /**
31
- * @inheritDoc
32
- */
33
- destroy(): void;
34
- }
@@ -1,99 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revision/revisionview
11
- */
12
- import type { BaseEvent, Locale } from 'ckeditor5/src/utils.js';
13
- import { View, type DropdownView } from 'ckeditor5/src/ui.js';
14
- import RevisionNameView from './revisionnameview.js';
15
- import '../../../theme/revision/revision.css';
16
- import type Revision from '../../revision.js';
17
- import type { RevisionAction } from '../revisionssidebar/revisionssidebar.js';
18
- declare const RevisionView_base: import("ckeditor5/src/utils.js").Mixed<typeof View, import("@ckeditor/ckeditor5-collaboration-core/src/utils/confirmmixin.js").ConfirmApi>;
19
- /**
20
- * TODO
21
- */
22
- export default class RevisionView extends /* #__PURE__ -- @preserve */ RevisionView_base {
23
- id: string;
24
- revisionNameView: RevisionNameView;
25
- /**
26
- * It holds the revision actions drop-down view if actions are provided,
27
- * or just empty text otherwise.
28
- */
29
- revisionActionsView: DropdownView | '';
30
- /**
31
- * @observable
32
- */
33
- name: string;
34
- /**
35
- * @observable
36
- */
37
- createdAt: Date;
38
- /**
39
- * @observable
40
- */
41
- isSelected: boolean;
42
- /**
43
- * @observable
44
- */
45
- isHighlighted: boolean;
46
- /**
47
- * @observable
48
- */
49
- isActionsDropdownOpen: boolean;
50
- /**
51
- * @observable
52
- */
53
- isReady: boolean;
54
- /**
55
- * @observable
56
- */
57
- isEnabled: boolean;
58
- constructor(locale: Locale, revision: Revision, revisionActions: Array<RevisionAction>, requireRevisionName: boolean);
59
- /**
60
- * @inheritDoc
61
- */
62
- render(): void;
63
- /**
64
- * TODO
65
- */
66
- select(): void;
67
- /**
68
- * TODO
69
- */
70
- deselect(): void;
71
- /**
72
- * TODO
73
- */
74
- highlight(): void;
75
- /**
76
- * TODO
77
- */
78
- unhighlight(): void;
79
- }
80
- /**
81
- * @eventName setName | revisionSetName
82
- */
83
- export interface RevisionSetNameEvent extends BaseEvent {
84
- name: 'setName' | 'revisionSetName';
85
- args: [{
86
- id: string;
87
- name: string;
88
- }];
89
- }
90
- /**
91
- * @eventName select | revisionSelected
92
- */
93
- export interface RevisionSelectedEvent extends BaseEvent {
94
- name: 'select' | 'revisionSelected';
95
- args: [{
96
- id: string;
97
- }];
98
- }
99
- export {};
@@ -1,25 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revision/subrevisioncollapserview
11
- */
12
- import { View } from 'ckeditor5/src/ui.js';
13
- import type { Locale } from 'ckeditor5/src/utils.js';
14
- import '../../../theme/revision/subrevisioncollapser.css';
15
- export default class SubrevisionCollapserView extends View {
16
- /**
17
- * @observable
18
- */
19
- isVisible: boolean;
20
- constructor(locale: Locale);
21
- /**
22
- * TODO
23
- */
24
- toggle(): void;
25
- }
@@ -1,38 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revision/subrevisionview
11
- */
12
- import { View } from 'ckeditor5/src/ui.js';
13
- import type { Locale } from 'ckeditor5/src/utils.js';
14
- import '../../../theme/revision/subrevision.css';
15
- import type Revision from '../../revision.js';
16
- /**
17
- * TODO
18
- */
19
- export default class SubrevisionView extends View {
20
- id: string;
21
- /**
22
- * @observable
23
- */
24
- createdAt: Date;
25
- /**
26
- * @observable
27
- */
28
- isSelected: boolean;
29
- constructor(locale: Locale, subRevision: Revision, parentRevisionId: string);
30
- /**
31
- * TODO
32
- */
33
- select(): void;
34
- /**
35
- * TODO
36
- */
37
- deselect(): void;
38
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- export {};
@@ -1,61 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revisionhistory/revisionhistorysaverevisionformview
11
- */
12
- import { LabeledFieldView, View, type InputTextView } from 'ckeditor5/src/ui.js';
13
- import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
14
- import '../../../theme/revisionhistorysaverevisionform.css';
15
- import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
16
- /**
17
- * The media form view controller class.
18
- *
19
- * See {@link module:media-embed/ui/mediaformview~MediaFormView}.
20
- */
21
- export default class RevisionHistorySaveRevisionFormView extends View {
22
- /**
23
- * Tracks information about the DOM focus in the form.
24
- */
25
- readonly focusTracker: FocusTracker;
26
- /**
27
- * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
28
- */
29
- readonly keystrokes: KeystrokeHandler;
30
- /**
31
- * The revision name input view.
32
- */
33
- revisionNameInputView: LabeledFieldView<InputTextView>;
34
- /**
35
- * The value of the revision name input.
36
- *
37
- * @observable
38
- */
39
- revisionNameInputValue: string;
40
- constructor(locale: Locale, requireRevisionName: boolean);
41
- /**
42
- * @inheritDoc
43
- */
44
- render(): void;
45
- /**
46
- * Focuses the {@link #revisionNameInputView}.
47
- */
48
- focus(): void;
49
- /**
50
- * The native DOM `value` of the {@link #revisionNameInputView} element.
51
- *
52
- * **Note**: Do not confuse it with the {@link module:ui/inputtext/inputtextview~InputTextView#value}
53
- * which works one way only and may not represent the actual state of the component in the DOM.
54
- */
55
- get revisionName(): string;
56
- set revisionName(name: string);
57
- /**
58
- * TODO
59
- */
60
- reset(): void;
61
- }
@@ -1,38 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revisionhistory/revisionhistoryui
11
- */
12
- import { Plugin } from 'ckeditor5/src/core.js';
13
- import RevisionTracker from '../../revisiontracker.js';
14
- /**
15
- * TODO
16
- */
17
- export default class RevisionHistoryUI extends Plugin {
18
- /**
19
- * @inheritDoc
20
- */
21
- static get pluginName(): "RevisionHistoryUI";
22
- /**
23
- * @inheritDoc
24
- */
25
- static get isOfficialPlugin(): true;
26
- /**
27
- * @inheritDoc
28
- */
29
- static get isPremiumPlugin(): true;
30
- /**
31
- * @inheritDoc
32
- */
33
- static get requires(): readonly [typeof RevisionTracker];
34
- /**
35
- * @inheritDoc
36
- */
37
- init(): void;
38
- }
@@ -1,56 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
8
- */
9
- /**
10
- * @module revision-history/ui/revisionsidebar/revisionsidebar
11
- */
12
- import { Plugin, type Editor } from 'ckeditor5/src/core.js';
13
- import RevisionViewer from '../../revisionviewer.js';
14
- import type { default as RevisionView } from '../revision/revisionview.js';
15
- /**
16
- * TODO
17
- */
18
- export default class RevisionsSidebar extends Plugin {
19
- static defaultRevisionActions: Array<string>;
20
- static availableRevisionActions: Record<string, RevisionAction>;
21
- /**
22
- * @inheritDoc
23
- */
24
- static get pluginName(): "RevisionsSidebar";
25
- /**
26
- * @inheritDoc
27
- */
28
- static get isOfficialPlugin(): true;
29
- /**
30
- * @inheritDoc
31
- */
32
- static get isPremiumPlugin(): true;
33
- /**
34
- * @inheritDoc
35
- */
36
- static get requires(): readonly [typeof RevisionViewer];
37
- /**
38
- * @inheritDoc
39
- */
40
- constructor(editor: Editor);
41
- /**
42
- * @inheritDoc
43
- */
44
- init(): void;
45
- /**
46
- * @inheritDoc
47
- */
48
- destroy(): void;
49
- }
50
- export interface RevisionAction {
51
- name: string;
52
- class?: string;
53
- action: (editor: Editor, revisionView: RevisionView) => void;
54
- isVisible?: (editor: Editor, revisionView: RevisionView) => boolean;
55
- isEnabled?: (editor: Editor, revisionView: RevisionView) => boolean;
56
- }