@ckeditor/ckeditor-cloud-services-collaboration 52.0.1 → 52.1.4

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 (207) hide show
  1. package/package.json +2 -1
  2. package/src/ckeditorcloudserviceserror.js +2 -2
  3. package/src/ckeditorcloudservicesservererror.js +2 -2
  4. package/src/collaborativeeditingservice/collaborativeeditingservice.js +2 -2
  5. package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.js +2 -2
  6. package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.js +2 -2
  7. package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.js +2 -2
  8. package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.js +2 -2
  9. package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.js +2 -2
  10. package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.js +2 -2
  11. package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.js +2 -2
  12. package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.js +2 -2
  13. package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.js +2 -2
  14. package/src/comments-v2/commentsservice.js +2 -2
  15. package/src/comments-v2/descriptors/commentdescriptor.js +2 -2
  16. package/src/comments-v2/descriptors/commentsthreaddescriptor.js +2 -2
  17. package/src/comments-v2/descriptors/commentthreadaddedcomment.js +2 -2
  18. package/src/comments-v2/messages/addcommentmessage.js +2 -2
  19. package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.js +2 -2
  20. package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.js +2 -2
  21. package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.js +2 -2
  22. package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.js +2 -2
  23. package/src/comments-v2/messages/connectmessage.js +2 -2
  24. package/src/comments-v2/messages/getcommentthreadmessage.js +2 -2
  25. package/src/comments-v2/messages/getdocumentthreadsmessage.js +2 -2
  26. package/src/comments-v2/messages/removecommentmessage.js +2 -2
  27. package/src/comments-v2/messages/removecommentthreadmessage.js +2 -2
  28. package/src/comments-v2/messages/updatecommentmessage.js +2 -2
  29. package/src/comments-v2/responses/addcommentresponse.js +2 -2
  30. package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.js +2 -2
  31. package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.js +2 -2
  32. package/src/comments-v2/responses/connectresponse.js +2 -2
  33. package/src/comments-v2/responses/getcommentthreadresponse.js +2 -2
  34. package/src/comments-v2/responses/getdocumentthreadsresponse.js +2 -2
  35. package/src/compiledmessages.d.ts +8313 -9
  36. package/src/compiledmessages.js +2 -2
  37. package/src/descriptor.js +2 -2
  38. package/src/descriptors/keyvaluedescriptor.js +2 -2
  39. package/src/editor/editorservice.js +2 -2
  40. package/src/editor/messages/iseditorbundleuploadedmessage.js +2 -2
  41. package/src/editor/responses/iseditorbundleuploadedresponse.js +2 -2
  42. package/src/errors/ServiceNotConnectedError.js +2 -2
  43. package/src/index.js +2 -2
  44. package/src/message.js +2 -2
  45. package/src/messagescompressor.js +2 -2
  46. package/src/messagesmapper.js +2 -2
  47. package/src/revision-history/descriptors/revisiondescriptor.js +2 -2
  48. package/src/revision-history/messages/revisionhistoryconnectmessage.js +2 -2
  49. package/src/revision-history/messages/revisionhistorygetrevisionmessage.js +2 -2
  50. package/src/revision-history/messages/revisionhistoryreconnectmessage.js +2 -2
  51. package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.js +2 -2
  52. package/src/revision-history/responses/revisionhistoryconnectresponse.js +2 -2
  53. package/src/revision-history/responses/revisionhistorygetrevisionresponse.js +2 -2
  54. package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.js +2 -2
  55. package/src/revision-history/revision.js +2 -2
  56. package/src/revision-history/revisionhistoryservice.js +2 -2
  57. package/src/services.js +2 -2
  58. package/src/sessions/descriptors/sessiondescriptor.js +2 -2
  59. package/src/sessions/messages/sessionsconnectmessage.js +2 -2
  60. package/src/sessions/messages/socketconnectmessage.js +2 -2
  61. package/src/sessions/messages/socketdisconnectmessage.js +2 -2
  62. package/src/sessions/responses/sessionsconnectresponse.js +2 -2
  63. package/src/sessions/sessioncollection.js +2 -2
  64. package/src/sessions/sessions.js +2 -2
  65. package/src/track-changes/descriptors/suggestiondescriptor.js +2 -2
  66. package/src/track-changes/messages/addsuggestionmessage.js +2 -2
  67. package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.js +2 -2
  68. package/src/track-changes/messages/connectmessage.js +2 -2
  69. package/src/track-changes/messages/getallsuggestionsmessage.js +2 -2
  70. package/src/track-changes/messages/getsuggestionmessage.js +2 -2
  71. package/src/track-changes/messages/updatesuggestionmessage.js +2 -2
  72. package/src/track-changes/responses/addsuggestionresponse.js +2 -2
  73. package/src/track-changes/responses/connectresponse.js +2 -2
  74. package/src/track-changes/responses/getallsuggestionsresponse.js +2 -2
  75. package/src/track-changes/responses/getsuggestionresponse.js +2 -2
  76. package/src/track-changes/trackchangesservice.js +2 -2
  77. package/src/types.js +2 -2
  78. package/src/users/descriptors/userdescriptor.js +2 -2
  79. package/src/users/messages/getmanyusersmessage.js +2 -2
  80. package/src/users/messages/getusermessage.js +2 -2
  81. package/src/users/responses/getmanyusersresponse.js +2 -2
  82. package/src/users/responses/getuserresponse.js +2 -2
  83. package/src/users/user.js +2 -2
  84. package/src/version.js +2 -2
  85. package/src/websocketgateway/channel.js +2 -2
  86. package/src/websocketgateway/messages/channelmessage.js +2 -2
  87. package/src/websocketgateway/parser/packetparser.js +2 -2
  88. package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.js +2 -2
  89. package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.js +2 -2
  90. package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.js +2 -2
  91. package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.js +2 -2
  92. package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.js +2 -2
  93. package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.js +2 -2
  94. package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.js +2 -2
  95. package/src/websocketgateway/parser/packets/packagedatamessage.js +2 -2
  96. package/src/websocketgateway/parser/packets/packetmessage.js +2 -2
  97. package/src/websocketgateway/parser/packets/packetoptionsmessage.js +2 -2
  98. package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.js +2 -2
  99. package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.js +2 -2
  100. package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.js +2 -2
  101. package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.js +2 -2
  102. package/src/websocketgateway/parser/parser.js +2 -2
  103. package/src/websocketgateway/parser/parserutils.js +2 -2
  104. package/src/websocketgateway/requestsmanager.js +2 -2
  105. package/src/websocketgateway/websocketgateway.js +2 -2
  106. package/src/ckeditorcloudserviceserror.d.ts +0 -8
  107. package/src/ckeditorcloudservicesservererror.d.ts +0 -15
  108. package/src/collaborativeeditingservice/collaborativeeditingservice.d.ts +0 -127
  109. package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.d.ts +0 -18
  110. package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.d.ts +0 -11
  111. package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.d.ts +0 -24
  112. package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.d.ts +0 -19
  113. package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.d.ts +0 -38
  114. package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.d.ts +0 -16
  115. package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.d.ts +0 -68
  116. package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.d.ts +0 -51
  117. package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.d.ts +0 -28
  118. package/src/comments-v2/commentsservice.d.ts +0 -72
  119. package/src/comments-v2/descriptors/commentdescriptor.d.ts +0 -23
  120. package/src/comments-v2/descriptors/commentsthreaddescriptor.d.ts +0 -31
  121. package/src/comments-v2/descriptors/commentthreadaddedcomment.d.ts +0 -15
  122. package/src/comments-v2/messages/addcommentmessage.d.ts +0 -30
  123. package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.d.ts +0 -32
  124. package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.d.ts +0 -17
  125. package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.d.ts +0 -21
  126. package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.d.ts +0 -23
  127. package/src/comments-v2/messages/connectmessage.d.ts +0 -15
  128. package/src/comments-v2/messages/getcommentthreadmessage.d.ts +0 -17
  129. package/src/comments-v2/messages/getdocumentthreadsmessage.d.ts +0 -15
  130. package/src/comments-v2/messages/removecommentmessage.d.ts +0 -19
  131. package/src/comments-v2/messages/removecommentthreadmessage.d.ts +0 -17
  132. package/src/comments-v2/messages/updatecommentmessage.d.ts +0 -28
  133. package/src/comments-v2/responses/addcommentresponse.d.ts +0 -17
  134. package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.d.ts +0 -22
  135. package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.d.ts +0 -19
  136. package/src/comments-v2/responses/connectresponse.d.ts +0 -19
  137. package/src/comments-v2/responses/getcommentthreadresponse.d.ts +0 -33
  138. package/src/comments-v2/responses/getdocumentthreadsresponse.d.ts +0 -17
  139. package/src/descriptor.d.ts +0 -13
  140. package/src/descriptors/keyvaluedescriptor.d.ts +0 -5
  141. package/src/editor/editorservice.d.ts +0 -11
  142. package/src/editor/messages/iseditorbundleuploadedmessage.d.ts +0 -15
  143. package/src/editor/responses/iseditorbundleuploadedresponse.d.ts +0 -13
  144. package/src/errors/ServiceNotConnectedError.d.ts +0 -4
  145. package/src/index.d.ts +0 -66
  146. package/src/message.d.ts +0 -17
  147. package/src/messagescompressor.d.ts +0 -15
  148. package/src/messagesmapper.d.ts +0 -9
  149. package/src/revision-history/descriptors/revisiondescriptor.d.ts +0 -42
  150. package/src/revision-history/messages/revisionhistoryconnectmessage.d.ts +0 -15
  151. package/src/revision-history/messages/revisionhistorygetrevisionmessage.d.ts +0 -17
  152. package/src/revision-history/messages/revisionhistoryreconnectmessage.d.ts +0 -17
  153. package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.d.ts +0 -41
  154. package/src/revision-history/responses/revisionhistoryconnectresponse.d.ts +0 -30
  155. package/src/revision-history/responses/revisionhistorygetrevisionresponse.d.ts +0 -30
  156. package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.d.ts +0 -13
  157. package/src/revision-history/revision.d.ts +0 -15
  158. package/src/revision-history/revisionhistoryservice.d.ts +0 -75
  159. package/src/services.d.ts +0 -8
  160. package/src/sessions/descriptors/sessiondescriptor.d.ts +0 -5
  161. package/src/sessions/messages/sessionsconnectmessage.d.ts +0 -17
  162. package/src/sessions/messages/socketconnectmessage.d.ts +0 -21
  163. package/src/sessions/messages/socketdisconnectmessage.d.ts +0 -15
  164. package/src/sessions/responses/sessionsconnectresponse.d.ts +0 -21
  165. package/src/sessions/sessioncollection.d.ts +0 -39
  166. package/src/sessions/sessions.d.ts +0 -14
  167. package/src/track-changes/descriptors/suggestiondescriptor.d.ts +0 -25
  168. package/src/track-changes/messages/addsuggestionmessage.d.ts +0 -25
  169. package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts +0 -19
  170. package/src/track-changes/messages/connectmessage.d.ts +0 -15
  171. package/src/track-changes/messages/getallsuggestionsmessage.d.ts +0 -15
  172. package/src/track-changes/messages/getsuggestionmessage.d.ts +0 -17
  173. package/src/track-changes/messages/updatesuggestionmessage.d.ts +0 -25
  174. package/src/track-changes/responses/addsuggestionresponse.d.ts +0 -27
  175. package/src/track-changes/responses/connectresponse.d.ts +0 -19
  176. package/src/track-changes/responses/getallsuggestionsresponse.d.ts +0 -17
  177. package/src/track-changes/responses/getsuggestionresponse.d.ts +0 -27
  178. package/src/track-changes/trackchangesservice.d.ts +0 -62
  179. package/src/types.d.ts +0 -7
  180. package/src/users/descriptors/userdescriptor.d.ts +0 -5
  181. package/src/users/messages/getmanyusersmessage.d.ts +0 -15
  182. package/src/users/messages/getusermessage.d.ts +0 -15
  183. package/src/users/responses/getmanyusersresponse.d.ts +0 -13
  184. package/src/users/responses/getuserresponse.d.ts +0 -13
  185. package/src/users/user.d.ts +0 -41
  186. package/src/version.d.ts +0 -2
  187. package/src/websocketgateway/channel.d.ts +0 -31
  188. package/src/websocketgateway/messages/channelmessage.d.ts +0 -21
  189. package/src/websocketgateway/parser/packetparser.d.ts +0 -15
  190. package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.d.ts +0 -18
  191. package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.d.ts +0 -18
  192. package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.d.ts +0 -17
  193. package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.d.ts +0 -17
  194. package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.d.ts +0 -17
  195. package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.d.ts +0 -18
  196. package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.d.ts +0 -17
  197. package/src/websocketgateway/parser/packets/packagedatamessage.d.ts +0 -16
  198. package/src/websocketgateway/parser/packets/packetmessage.d.ts +0 -31
  199. package/src/websocketgateway/parser/packets/packetoptionsmessage.d.ts +0 -18
  200. package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.d.ts +0 -18
  201. package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.d.ts +0 -17
  202. package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.d.ts +0 -17
  203. package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.d.ts +0 -17
  204. package/src/websocketgateway/parser/parser.d.ts +0 -14
  205. package/src/websocketgateway/parser/parserutils.d.ts +0 -27
  206. package/src/websocketgateway/requestsmanager.d.ts +0 -20
  207. package/src/websocketgateway/websocketgateway.d.ts +0 -164
@@ -1,30 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- import { IRevisionObject } from '../revision';
4
- import { IRevisionJSON, IRevision } from '../descriptors/revisiondescriptor';
5
- export interface IRevisionHistoryGetRevisionResponseJSON extends IRevisionJSON, IMessage {
6
- }
7
- export default class RevisionHistoryGetRevisionResponse extends Message implements IRevision {
8
- readonly revisionId: string;
9
- readonly name?: string | undefined;
10
- readonly creatorId?: string | undefined;
11
- readonly authorsIds?: string[] | undefined;
12
- readonly createdAt?: Date | undefined;
13
- readonly diffData?: string | undefined;
14
- readonly attributes?: Record<string, unknown> | undefined;
15
- readonly fromVersion?: number | undefined;
16
- readonly toVersion?: number | undefined;
17
- readonly isEmptyCurrent?: boolean | undefined;
18
- static readonly DESCRIPTOR_NAME: string;
19
- static readonly DESCRIPTOR: IDescriptorBody;
20
- constructor(revisionId: string, name?: string | undefined, creatorId?: string | undefined, authorsIds?: string[] | undefined, createdAt?: Date | undefined, diffData?: string | undefined, attributes?: Record<string, unknown> | undefined, fromVersion?: number | undefined, toVersion?: number | undefined, isEmptyCurrent?: boolean | undefined);
21
- toJSON(): IRevisionHistoryGetRevisionResponseJSON;
22
- /**
23
- * Creates frontend revision model from message sent from the backend.
24
- *
25
- * This method is intended to be used on the frontend side after receiving the response from the backend.
26
- */
27
- toObject(): IRevisionObject;
28
- static create(params: IRevision): RevisionHistoryGetRevisionResponse;
29
- static fromJSON(json: IRevisionHistoryGetRevisionResponseJSON): RevisionHistoryGetRevisionResponse;
30
- }
@@ -1,13 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IRevisionHistoryUpdateRevisionsResponse extends IMessage {
4
- requestId: number;
5
- }
6
- export default class RevisionHistoryUpdateRevisionsResponse extends Message {
7
- readonly requestId: number;
8
- static readonly DESCRIPTOR_NAME: string;
9
- static readonly DESCRIPTOR: IDescriptorBody;
10
- constructor(requestId: number);
11
- toJSON(): IRevisionHistoryUpdateRevisionsResponse;
12
- static fromJSON(json: IRevisionHistoryUpdateRevisionsResponse): RevisionHistoryUpdateRevisionsResponse;
13
- }
@@ -1,15 +0,0 @@
1
- /**
2
- * Revision History model used on the frontend side.
3
- */
4
- export interface IRevisionObject {
5
- id: string;
6
- name?: string;
7
- creatorId?: string;
8
- authorsIds?: string[];
9
- fromVersion?: number;
10
- toVersion?: number;
11
- createdAt?: Date;
12
- isEmptyCurrent?: boolean;
13
- diffData?: Record<string, unknown>;
14
- attributes?: Record<string, unknown>;
15
- }
@@ -1,75 +0,0 @@
1
- import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
2
- import { IRevisionObject } from './revision';
3
- export declare const _SERVICE: number;
4
- interface IRevisionHistoryConnectResponse {
5
- revisions: IRevisionObject[];
6
- requestId: number;
7
- }
8
- declare const RevisionHistoryService_base: {
9
- new (): import("ckeditor5/src/utils").Emitter;
10
- prototype: import("ckeditor5/src/utils").Emitter;
11
- };
12
- declare class RevisionHistoryService extends RevisionHistoryService_base {
13
- private readonly _documentId;
14
- private _isConnected;
15
- private _wsGateway?;
16
- private _channel?;
17
- private static readonly _SERVICE;
18
- constructor(_documentId: string);
19
- get isConnected(): boolean;
20
- /**
21
- * Connects RevisionHistoryService to CKEditor Cloud Services.
22
- *
23
- * @throws {@link CKEditorCloudServicesError} error
24
- * Thrown in the case of errors on the backend side.
25
- */
26
- connect(wsGateway: IWebSocketGateway): Promise<IRevisionHistoryConnectResponse | void>;
27
- /**
28
- * Disconnects RevisionHistoryService from CKEditor Cloud Services.
29
- *
30
- * @throws {@link CKEditorCloudServicesError}
31
- * Thrown in the case of errors on the backend side.
32
- */
33
- disconnect(): void;
34
- /**
35
- * Reconnects RevisionHistoryService to CKEditor Cloud Services.
36
- *
37
- * @throws {@link CKEditorCloudServicesError}
38
- * Thrown when connection already exists or in the case of errors on the backend side.
39
- */
40
- reconnect(wsGateway: IWebSocketGateway, lastRequestId: number): Promise<IRevisionHistoryConnectResponse>;
41
- /**
42
- * Updates revisions.
43
- *
44
- * @throws {@link CKEditorCloudServicesError}
45
- * Thrown in the case of errors on the backend side.
46
- */
47
- updateRevisions(revisions: IRevisionObject[], lastRequestId: number): Promise<number>;
48
- /**
49
- * Returns revision with given id.
50
- *
51
- * @throws {@link CKEditorCloudServicesError}
52
- * Thrown in the case of errors on the backend side.
53
- */
54
- getRevision(revisionId: string): Promise<IRevisionObject>;
55
- /**
56
- * Connects or reconnects to WebSocketGateway and starts listening on channel.
57
- */
58
- private _connect;
59
- /**
60
- * Starts to listen on a given channel.
61
- */
62
- private _connectToChannel;
63
- /**
64
- * Processes websocket gateway state changes.
65
- */
66
- private _onWsGatewayStateChange;
67
- /**
68
- * Sends request to RevisionHistory service.
69
- *
70
- * @throws {@link ServiceNotConnectedError}
71
- * Thrown in the case of missing service connection.
72
- */
73
- private _sendRequest;
74
- }
75
- export default RevisionHistoryService;
package/src/services.d.ts DELETED
@@ -1,8 +0,0 @@
1
- import WebSocketGateway, { WEB_SOCKET_GATEWAY_STATES } from './websocketgateway/websocketgateway';
2
- import EditorService from './editor/editorservice';
3
- import RevisionHistoryService from './revision-history/revisionhistoryservice';
4
- import TrackChangesService from './track-changes/trackchangesservice';
5
- import SessionCollection, { ISocket } from './sessions/sessioncollection';
6
- import CollaborativeEditingService from './collaborativeeditingservice/collaborativeeditingservice';
7
- import CommentsService from './comments-v2/commentsservice';
8
- export { CollaborativeEditingService, RevisionHistoryService, EditorService, WebSocketGateway, TrackChangesService, SessionCollection, ISocket, CommentsService, WEB_SOCKET_GATEWAY_STATES };
@@ -1,5 +0,0 @@
1
- import Descriptor, { IDescriptorBody } from './../../descriptor';
2
- export default class SessionsSocketDescriptor extends Descriptor {
3
- static readonly DESCRIPTOR_NAME: string;
4
- static readonly DESCRIPTOR: IDescriptorBody;
5
- }
@@ -1,17 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface ISessionsConnectMessage extends IMessage {
4
- id: string;
5
- sessionType: number | string;
6
- }
7
- export default class SessionsConnectMessage extends Message {
8
- readonly id: string;
9
- readonly sessionType: string | number;
10
- static readonly TYPE: string;
11
- static readonly READABLE_TYPE_NAME: string;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(id: string, sessionType: string | number);
15
- toJSON(): ISessionsConnectMessage;
16
- static fromJSON(data: ISessionsConnectMessage): SessionsConnectMessage;
17
- }
@@ -1,21 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface ISocketConnectMessage extends IMessage {
4
- id: string;
5
- userId?: string;
6
- role?: string;
7
- permissions?: string[];
8
- }
9
- export default class SocketConnectMessage extends Message {
10
- readonly id: string;
11
- readonly userId?: string | undefined;
12
- readonly role?: string | undefined;
13
- readonly permissions?: string[] | undefined;
14
- static readonly TYPE: string;
15
- static readonly READABLE_TYPE_NAME: string;
16
- static readonly DESCRIPTOR_NAME: string;
17
- static readonly DESCRIPTOR: IDescriptorBody;
18
- constructor(id: string, userId?: string | undefined, role?: string | undefined, permissions?: string[] | undefined);
19
- toJSON(): ISocketConnectMessage;
20
- static fromJSON(data: ISocketConnectMessage): SocketConnectMessage;
21
- }
@@ -1,15 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface ISocketDisconnectMessage extends IMessage {
4
- id: string;
5
- }
6
- export default class SocketDisconnectMessage extends Message {
7
- readonly id: string;
8
- static readonly TYPE: string;
9
- static readonly READABLE_TYPE_NAME: string;
10
- static readonly DESCRIPTOR_NAME: string;
11
- static readonly DESCRIPTOR: IDescriptorBody;
12
- constructor(id: string);
13
- toJSON(): ISocketDisconnectMessage;
14
- static fromJSON(data: ISocketDisconnectMessage): SocketDisconnectMessage;
15
- }
@@ -1,21 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- import { ISocket } from '../sessioncollection';
4
- export interface ISessionsConnectResponse extends IMessage {
5
- channel: string;
6
- sockets: {
7
- user?: string;
8
- session: string;
9
- role?: string;
10
- permissions?: string[];
11
- }[];
12
- }
13
- export default class SessionsConnectResponse extends Message {
14
- readonly channel: string;
15
- readonly sockets: ISocket[];
16
- static readonly DESCRIPTOR_NAME: string;
17
- static readonly DESCRIPTOR: IDescriptorBody;
18
- constructor(channel: string, sockets?: ISocket[]);
19
- toJSON(): ISessionsConnectResponse;
20
- static fromJSON(data: ISessionsConnectResponse): SessionsConnectResponse;
21
- }
@@ -1,39 +0,0 @@
1
- import { Collection } from 'ckeditor5/src/utils';
2
- import User from './../users/user';
3
- import { IWebSocketGateway } from './../websocketgateway/websocketgateway';
4
- export interface ISocket {
5
- id: string;
6
- user?: User;
7
- userId?: string;
8
- role?: string;
9
- permissions?: string[];
10
- }
11
- /**
12
- * Collection of connected socket to given service.
13
- */
14
- declare class SessionCollection extends Collection<ISocket> {
15
- private readonly _id;
16
- private readonly _sessionType;
17
- private readonly _handlers;
18
- private _channel?;
19
- private _wsGateway?;
20
- private _connected;
21
- private _eventsQueue;
22
- private _isRunning;
23
- constructor(_id: string, _sessionType: number);
24
- /**
25
- * Connects SessionCollection to CKEditor Cloud Services..
26
- */
27
- connect(wsGateway: IWebSocketGateway): Promise<void>;
28
- /**
29
- * Disconnects SessionCollection from CKEditor Cloud Services.
30
- */
31
- disconnect(force?: boolean): void;
32
- add(_1: ISocket, _2?: number): this;
33
- remove(_: number): ISocket;
34
- private _connectToChannel;
35
- private _onWsGatewayStateChange;
36
- private _runQueue;
37
- private _addHandler;
38
- }
39
- export default SessionCollection;
@@ -1,14 +0,0 @@
1
- import SessionCollection from './sessioncollection';
2
- import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
3
- export declare const _SERVICE: number;
4
- /**
5
- * Abstracts requesting connected Sessions for services. Should not be used directly
6
- */
7
- export default class Sessions {
8
- /**
9
- * Returns a Promise that resolves with read-only observable collection with EndUsers Sessions for given service instance.
10
- *
11
- * const sessions = await wsGateway.getConnectedSessions( wsGateway, 'some-uuid', 'session-type' );
12
- */
13
- static getConnectedSessions(wsGateway: IWebSocketGateway, id: string, sessionType: number): Promise<SessionCollection>;
14
- }
@@ -1,25 +0,0 @@
1
- import Descriptor, { IDescriptorBody } from './../../descriptor';
2
- interface ICommonSuggestion {
3
- id: string;
4
- authorId: string;
5
- type: string;
6
- hasComments?: boolean;
7
- state?: string;
8
- }
9
- export interface ISuggestion extends ICommonSuggestion {
10
- createdAt?: Date;
11
- data?: Record<string, unknown> | null;
12
- attributes?: Record<string, unknown> | null;
13
- }
14
- export interface ISuggestionJSON extends ICommonSuggestion {
15
- createdAt?: string;
16
- data?: string | null;
17
- attributes?: string | null;
18
- }
19
- export default class SuggestionDescriptor extends Descriptor {
20
- static readonly DESCRIPTOR_NAME: string;
21
- static readonly DESCRIPTOR: IDescriptorBody;
22
- static toJSON(suggestion: ISuggestion): ISuggestionJSON;
23
- static fromJSON(suggestion: ISuggestionJSON): ISuggestion;
24
- }
25
- export {};
@@ -1,25 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IAddSuggestionMessage extends IMessage {
4
- id: string;
5
- documentId: string;
6
- type: string;
7
- data: string;
8
- originalSuggestionId: string | null;
9
- attributes: string | null;
10
- }
11
- export default class AddSuggestionMessage extends Message {
12
- readonly id: string;
13
- readonly documentId: string;
14
- readonly type: string;
15
- readonly data: Record<string, unknown>;
16
- readonly originalSuggestionId: string | null;
17
- readonly attributes: Record<string, unknown> | null;
18
- static readonly TYPE: string;
19
- static readonly READABLE_TYPE_NAME: string;
20
- static readonly DESCRIPTOR_NAME: string;
21
- static readonly DESCRIPTOR: IDescriptorBody;
22
- constructor(id: string, documentId: string, type: string, data?: Record<string, unknown>, originalSuggestionId?: string | null, attributes?: Record<string, unknown> | null);
23
- toJSON(): IAddSuggestionMessage;
24
- static fromJSON(object: IAddSuggestionMessage): AddSuggestionMessage;
25
- }
@@ -1,19 +0,0 @@
1
- import Message from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IBatchUpdateSuggestionsStateMessage {
4
- ids: string[];
5
- documentId: string;
6
- state: string;
7
- }
8
- export default class BatchUpdateSuggestionsStateMessage extends Message {
9
- ids: string[];
10
- documentId: string;
11
- state: string;
12
- static readonly TYPE: string;
13
- static readonly READABLE_TYPE_NAME: string;
14
- static readonly DESCRIPTOR_NAME: string;
15
- static readonly DESCRIPTOR: IDescriptorBody;
16
- constructor(ids: string[], documentId: string, state: string);
17
- toJSON(): IBatchUpdateSuggestionsStateMessage;
18
- static fromJSON(object: IBatchUpdateSuggestionsStateMessage): BatchUpdateSuggestionsStateMessage;
19
- }
@@ -1,15 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IConnectMessage extends IMessage {
4
- documentId: string;
5
- }
6
- export default class ConnectMessage extends Message {
7
- readonly documentId: string;
8
- static readonly TYPE: string;
9
- static readonly READABLE_TYPE_NAME: string;
10
- static readonly DESCRIPTOR_NAME: string;
11
- static readonly DESCRIPTOR: IDescriptorBody;
12
- constructor(documentId: string);
13
- toJSON(): IConnectMessage;
14
- static fromJSON(object: IConnectMessage): ConnectMessage;
15
- }
@@ -1,15 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetAllSuggestionsMessage extends IMessage {
4
- documentId: string;
5
- }
6
- export default class GetAllSuggestionsMessage extends Message {
7
- readonly documentId: string;
8
- static readonly TYPE: string;
9
- static readonly READABLE_TYPE_NAME: string;
10
- static readonly DESCRIPTOR_NAME: string;
11
- static readonly DESCRIPTOR: IDescriptorBody;
12
- constructor(documentId: string);
13
- toJSON(): IGetAllSuggestionsMessage;
14
- static fromJSON(object: IGetAllSuggestionsMessage): GetAllSuggestionsMessage;
15
- }
@@ -1,17 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetSuggestionMessage extends IMessage {
4
- id: string;
5
- documentId: string;
6
- }
7
- export default class GetSuggestionMessage extends Message {
8
- readonly id: string;
9
- readonly documentId: string;
10
- static readonly TYPE: string;
11
- static readonly READABLE_TYPE_NAME: string;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(id: string, documentId: string);
15
- toJSON(): IGetSuggestionMessage;
16
- static fromJSON(object: IGetSuggestionMessage): GetSuggestionMessage;
17
- }
@@ -1,25 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IUpdateSuggestionMessage extends IMessage {
4
- id: string;
5
- documentId: string;
6
- hasComments?: boolean;
7
- isHasCommentsModified: boolean;
8
- state?: string;
9
- attributes: string;
10
- }
11
- export default class UpdateSuggestionMessage extends Message {
12
- readonly id: string;
13
- readonly documentId: string;
14
- readonly hasComments: boolean | undefined;
15
- readonly isHasCommentsModified: boolean;
16
- readonly state?: string | undefined;
17
- readonly attributes: Record<string, unknown> | null;
18
- static readonly TYPE: string;
19
- static readonly READABLE_TYPE_NAME: string;
20
- static readonly DESCRIPTOR_NAME: string;
21
- static readonly DESCRIPTOR: IDescriptorBody;
22
- constructor(id: string, documentId: string, hasComments: boolean | undefined, isHasCommentsModified: boolean, state?: string | undefined, attributes?: Record<string, unknown> | null);
23
- toJSON(): IUpdateSuggestionMessage;
24
- static fromJSON(object: IUpdateSuggestionMessage): UpdateSuggestionMessage;
25
- }
@@ -1,27 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IAddSuggestionResponse extends IMessage {
4
- id: string;
5
- authorId: string;
6
- type: string;
7
- createdAt?: string;
8
- data: string;
9
- hasComments?: boolean;
10
- state?: string;
11
- attributes: string | null;
12
- }
13
- export default class AddSuggestionResponse extends Message {
14
- readonly id: string;
15
- readonly authorId: string;
16
- readonly type: string;
17
- readonly hasComments?: boolean | undefined;
18
- readonly state?: string | undefined;
19
- readonly data: Record<string, unknown> | null;
20
- readonly attributes: Record<string, unknown> | null;
21
- readonly createdAt?: Date;
22
- static readonly DESCRIPTOR_NAME: string;
23
- static readonly DESCRIPTOR: IDescriptorBody;
24
- constructor(id: string, authorId: string, type: string, createdAt?: string, hasComments?: boolean | undefined, state?: string | undefined, data?: Record<string, unknown> | null, attributes?: Record<string, unknown> | null);
25
- toJSON(): IAddSuggestionResponse;
26
- static fromJSON(data: IAddSuggestionResponse): AddSuggestionResponse;
27
- }
@@ -1,19 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- import { ISuggestion, ISuggestionJSON } from '../descriptors/suggestiondescriptor';
4
- export interface IConnectResponse extends IMessage {
5
- channel: string;
6
- suggestions?: string[];
7
- suggestionsV2?: ISuggestionJSON[];
8
- }
9
- export default class ConnectResponse extends Message {
10
- readonly channel: string;
11
- private readonly _suggestions?;
12
- private readonly _suggestionsV2?;
13
- readonly suggestions: ISuggestion[];
14
- static readonly DESCRIPTOR_NAME: string;
15
- static readonly DESCRIPTOR: IDescriptorBody;
16
- constructor(channel: string, _suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined);
17
- toJSON(): IConnectResponse;
18
- static fromJSON(object: IConnectResponse): ConnectResponse;
19
- }
@@ -1,17 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- import { ISuggestion, ISuggestionJSON } from '../descriptors/suggestiondescriptor';
4
- export interface IGetAllSuggestionResponse extends IMessage {
5
- suggestions?: string[];
6
- suggestionsV2?: ISuggestionJSON[];
7
- }
8
- export default class GetAllSuggestionResponse extends Message {
9
- private readonly _suggestions?;
10
- private readonly _suggestionsV2?;
11
- readonly suggestions: ISuggestion[];
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(_suggestions?: ISuggestion[] | undefined, _suggestionsV2?: ISuggestion[] | undefined);
15
- toJSON(): IGetAllSuggestionResponse;
16
- static fromJSON(data: IGetAllSuggestionResponse): GetAllSuggestionResponse;
17
- }
@@ -1,27 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetSuggestionResponse extends IMessage {
4
- id: string;
5
- authorId: string;
6
- type: string;
7
- createdAt: string;
8
- data: string;
9
- hasComments: boolean;
10
- state: string;
11
- attributes: string | null;
12
- }
13
- export default class GetSuggestionResponse extends Message {
14
- readonly id: string;
15
- readonly authorId: string;
16
- readonly type: string;
17
- readonly hasComments: boolean;
18
- readonly state: string;
19
- readonly data: Record<string, unknown>;
20
- readonly attributes: Record<string, unknown> | null;
21
- readonly createdAt: Date;
22
- static readonly DESCRIPTOR_NAME: string;
23
- static readonly DESCRIPTOR: IDescriptorBody;
24
- constructor(id: string, authorId: string, type: string, createdAt: string, hasComments: boolean, state: string, data?: Record<string, unknown>, attributes?: Record<string, unknown> | null);
25
- toJSON(): IGetSuggestionResponse;
26
- static fromJSON(data: IGetSuggestionResponse): GetSuggestionResponse;
27
- }
@@ -1,62 +0,0 @@
1
- import AddSuggestionResponse from './responses/addsuggestionresponse';
2
- import GetSuggestionResponse from './responses/getsuggestionresponse';
3
- import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
4
- import { ISuggestion } from './descriptors/suggestiondescriptor';
5
- export declare const _SERVICE: number;
6
- interface ISuggestionUpdateProps {
7
- hasComments?: boolean;
8
- state?: string;
9
- attributes?: Record<string, unknown>;
10
- }
11
- export interface IBatchUpdateSuggestionsStateParams {
12
- ids: string[];
13
- state: string;
14
- }
15
- declare const TrackChangesService_base: {
16
- new (): import("ckeditor5/src/utils").Emitter;
17
- prototype: import("ckeditor5/src/utils").Emitter;
18
- };
19
- declare class TrackChangesService extends TrackChangesService_base {
20
- private readonly _documentId;
21
- private _isConnected;
22
- private _wsGateway?;
23
- private _channel?;
24
- private static readonly _SERVICE;
25
- constructor(_documentId: string);
26
- get isConnected(): boolean;
27
- /**
28
- * Connects to WebSocketGateway and starts listening on channel.
29
- */
30
- connect(wsGateway: IWebSocketGateway): Promise<ISuggestion[] | void>;
31
- /**
32
- * Disconnects TrackChangesService from CKEditor Cloud Services.
33
- */
34
- disconnect(): void;
35
- /**
36
- * Adds suggestion and returns AddSuggestionResponse.
37
- */
38
- add(id: string, type: string, data: Record<string, unknown>, originalSuggestionId?: string | null, attributes?: Record<string, unknown>): Promise<AddSuggestionResponse>;
39
- /**
40
- * Returns suggestion with given id.
41
- */
42
- get(id: string, attempt?: number): Promise<GetSuggestionResponse>;
43
- /**
44
- * Returns suggestions from given documentId.
45
- */
46
- getAll(): Promise<ISuggestion[]>;
47
- /**
48
- * Updates suggestion.
49
- */
50
- update(id: string, props?: ISuggestionUpdateProps): Promise<void>;
51
- batchUpdateState(params: IBatchUpdateSuggestionsStateParams): Promise<void>;
52
- /**
53
- * Starts to listen on a given channel.
54
- */
55
- private _connectToChannel;
56
- /**
57
- * Processes websocket gateway state changes.
58
- */
59
- private _onWsGatewayStateChange;
60
- private _sendRequest;
61
- }
62
- export default TrackChangesService;
package/src/types.d.ts DELETED
@@ -1,7 +0,0 @@
1
- export declare type TokenChangeValueEventCallback = (event: Record<string, unknown>, name: string, value: ArrayBuffer) => void | Promise<void>;
2
- export interface IToken {
3
- value: string | ArrayBuffer;
4
- refreshToken(): Promise<void> | void;
5
- on(event: string, handler: TokenChangeValueEventCallback): void;
6
- off(event: string, handler: TokenChangeValueEventCallback): void;
7
- }
@@ -1,5 +0,0 @@
1
- import Descriptor, { IDescriptorBody } from './../../descriptor';
2
- export default class UserDescriptor extends Descriptor {
3
- static readonly DESCRIPTOR_NAME: string;
4
- static readonly DESCRIPTOR: IDescriptorBody;
5
- }
@@ -1,15 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetManyUsersMessage extends IMessage {
4
- ids: string[];
5
- }
6
- export default class GetManyUsersMessage extends Message {
7
- readonly ids: string[];
8
- static readonly TYPE: string;
9
- static readonly READABLE_TYPE_NAME: string;
10
- static readonly DESCRIPTOR_NAME: string;
11
- static readonly DESCRIPTOR: IDescriptorBody;
12
- constructor(ids: string[]);
13
- toJSON(): IGetManyUsersMessage;
14
- static fromJSON(data: IGetManyUsersMessage): GetManyUsersMessage;
15
- }
@@ -1,15 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetUserMessage extends IMessage {
4
- id: string;
5
- }
6
- export default class GetUserMessage extends Message {
7
- readonly id: string;
8
- static readonly TYPE: string;
9
- static readonly READABLE_TYPE_NAME: string;
10
- static readonly DESCRIPTOR_NAME: string;
11
- static readonly DESCRIPTOR: IDescriptorBody;
12
- constructor(id: string);
13
- toJSON(): IGetUserMessage;
14
- static fromJSON(data: IGetUserMessage): GetUserMessage;
15
- }