@ckeditor/ckeditor-cloud-services-collaboration 52.1.0 → 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 +1 -1
  3. package/src/ckeditorcloudservicesservererror.js +1 -1
  4. package/src/collaborativeeditingservice/collaborativeeditingservice.js +1 -1
  5. package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.js +1 -1
  6. package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.js +1 -1
  7. package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.js +1 -1
  8. package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.js +1 -1
  9. package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.js +1 -1
  10. package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.js +1 -1
  11. package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.js +1 -1
  12. package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.js +1 -1
  13. package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.js +1 -1
  14. package/src/comments-v2/commentsservice.js +1 -1
  15. package/src/comments-v2/descriptors/commentdescriptor.js +1 -1
  16. package/src/comments-v2/descriptors/commentsthreaddescriptor.js +1 -1
  17. package/src/comments-v2/descriptors/commentthreadaddedcomment.js +1 -1
  18. package/src/comments-v2/messages/addcommentmessage.js +1 -1
  19. package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.js +1 -1
  20. package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.js +1 -1
  21. package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.js +1 -1
  22. package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.js +1 -1
  23. package/src/comments-v2/messages/connectmessage.js +1 -1
  24. package/src/comments-v2/messages/getcommentthreadmessage.js +1 -1
  25. package/src/comments-v2/messages/getdocumentthreadsmessage.js +1 -1
  26. package/src/comments-v2/messages/removecommentmessage.js +1 -1
  27. package/src/comments-v2/messages/removecommentthreadmessage.js +1 -1
  28. package/src/comments-v2/messages/updatecommentmessage.js +1 -1
  29. package/src/comments-v2/responses/addcommentresponse.js +1 -1
  30. package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.js +1 -1
  31. package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.js +1 -1
  32. package/src/comments-v2/responses/connectresponse.js +1 -1
  33. package/src/comments-v2/responses/getcommentthreadresponse.js +1 -1
  34. package/src/comments-v2/responses/getdocumentthreadsresponse.js +1 -1
  35. package/src/compiledmessages.d.ts +8313 -9
  36. package/src/compiledmessages.js +1 -1
  37. package/src/descriptor.js +1 -1
  38. package/src/descriptors/keyvaluedescriptor.js +1 -1
  39. package/src/editor/editorservice.js +1 -1
  40. package/src/editor/messages/iseditorbundleuploadedmessage.js +1 -1
  41. package/src/editor/responses/iseditorbundleuploadedresponse.js +1 -1
  42. package/src/errors/ServiceNotConnectedError.js +1 -1
  43. package/src/index.js +1 -1
  44. package/src/message.js +1 -1
  45. package/src/messagescompressor.js +1 -1
  46. package/src/messagesmapper.js +1 -1
  47. package/src/revision-history/descriptors/revisiondescriptor.js +1 -1
  48. package/src/revision-history/messages/revisionhistoryconnectmessage.js +1 -1
  49. package/src/revision-history/messages/revisionhistorygetrevisionmessage.js +1 -1
  50. package/src/revision-history/messages/revisionhistoryreconnectmessage.js +1 -1
  51. package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.js +1 -1
  52. package/src/revision-history/responses/revisionhistoryconnectresponse.js +1 -1
  53. package/src/revision-history/responses/revisionhistorygetrevisionresponse.js +1 -1
  54. package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.js +1 -1
  55. package/src/revision-history/revision.js +1 -1
  56. package/src/revision-history/revisionhistoryservice.js +1 -1
  57. package/src/services.js +1 -1
  58. package/src/sessions/descriptors/sessiondescriptor.js +1 -1
  59. package/src/sessions/messages/sessionsconnectmessage.js +1 -1
  60. package/src/sessions/messages/socketconnectmessage.js +1 -1
  61. package/src/sessions/messages/socketdisconnectmessage.js +1 -1
  62. package/src/sessions/responses/sessionsconnectresponse.js +1 -1
  63. package/src/sessions/sessioncollection.js +1 -1
  64. package/src/sessions/sessions.js +1 -1
  65. package/src/track-changes/descriptors/suggestiondescriptor.js +1 -1
  66. package/src/track-changes/messages/addsuggestionmessage.js +1 -1
  67. package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.js +1 -1
  68. package/src/track-changes/messages/connectmessage.js +1 -1
  69. package/src/track-changes/messages/getallsuggestionsmessage.js +1 -1
  70. package/src/track-changes/messages/getsuggestionmessage.js +1 -1
  71. package/src/track-changes/messages/updatesuggestionmessage.js +1 -1
  72. package/src/track-changes/responses/addsuggestionresponse.js +1 -1
  73. package/src/track-changes/responses/connectresponse.js +1 -1
  74. package/src/track-changes/responses/getallsuggestionsresponse.js +1 -1
  75. package/src/track-changes/responses/getsuggestionresponse.js +1 -1
  76. package/src/track-changes/trackchangesservice.js +1 -1
  77. package/src/types.js +1 -1
  78. package/src/users/descriptors/userdescriptor.js +1 -1
  79. package/src/users/messages/getmanyusersmessage.js +1 -1
  80. package/src/users/messages/getusermessage.js +1 -1
  81. package/src/users/responses/getmanyusersresponse.js +1 -1
  82. package/src/users/responses/getuserresponse.js +1 -1
  83. package/src/users/user.js +1 -1
  84. package/src/version.js +1 -1
  85. package/src/websocketgateway/channel.js +1 -1
  86. package/src/websocketgateway/messages/channelmessage.js +1 -1
  87. package/src/websocketgateway/parser/packetparser.js +1 -1
  88. package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.js +1 -1
  89. package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.js +1 -1
  90. package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.js +1 -1
  91. package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.js +1 -1
  92. package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.js +1 -1
  93. package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.js +1 -1
  94. package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.js +1 -1
  95. package/src/websocketgateway/parser/packets/packagedatamessage.js +1 -1
  96. package/src/websocketgateway/parser/packets/packetmessage.js +1 -1
  97. package/src/websocketgateway/parser/packets/packetoptionsmessage.js +1 -1
  98. package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.js +1 -1
  99. package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.js +1 -1
  100. package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.js +1 -1
  101. package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.js +1 -1
  102. package/src/websocketgateway/parser/parser.js +1 -1
  103. package/src/websocketgateway/parser/parserutils.js +1 -1
  104. package/src/websocketgateway/requestsmanager.js +1 -1
  105. package/src/websocketgateway/websocketgateway.js +1 -1
  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 -40
  166. package/src/sessions/sessions.d.ts +0 -13
  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,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
- }
@@ -1,13 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetManyUsersResponse extends IMessage {
4
- users: Record<string, unknown>[];
5
- }
6
- export default class GetManyUsersResponse extends Message {
7
- readonly users: Record<string, unknown>[];
8
- static readonly DESCRIPTOR_NAME: string;
9
- static readonly DESCRIPTOR: IDescriptorBody;
10
- constructor(users: Record<string, unknown>[]);
11
- toJSON(): IGetManyUsersResponse;
12
- static fromJSON(data: IGetManyUsersResponse): GetManyUsersResponse;
13
- }
@@ -1,13 +0,0 @@
1
- import Message, { IMessage } from './../../message';
2
- import { IDescriptorBody } from '../../descriptor';
3
- export interface IGetUserResponse extends IMessage {
4
- attributes: Record<string, string>[];
5
- }
6
- export default class GetUserResponse extends Message {
7
- readonly attributes: Record<string, unknown>;
8
- static readonly DESCRIPTOR_NAME: string;
9
- static readonly DESCRIPTOR: IDescriptorBody;
10
- constructor(attributes: Record<string, unknown>);
11
- toJSON(): IGetUserResponse;
12
- static fromJSON(data: IGetUserResponse): GetUserResponse;
13
- }
@@ -1,41 +0,0 @@
1
- import { IWebSocketGateway } from '../websocketgateway/websocketgateway';
2
- interface IUserData extends Record<string, unknown> {
3
- id?: string;
4
- }
5
- /**
6
- * Represents User entity.
7
- */
8
- declare class User {
9
- static readonly _SERVICE: number;
10
- readonly id?: string;
11
- private readonly _attributes;
12
- /**
13
- * Creates User object. Passed attributes will be set on instance as a read-only attributes.
14
- * Passing undefined or empty object will create "Anonymous" object.
15
- */
16
- constructor(attributes?: IUserData);
17
- /**
18
- * Creates User from data object, ie. from token data.
19
- *
20
- * const user = User.fromData( { id: '1234', name: 'Bob' } );
21
- *
22
- * // Anonymous user will have no attributes.
23
- * const anonymous = User.fromData();
24
- */
25
- static fromData(data: IUserData): User;
26
- /**
27
- * Returns existing User from server or create a User object.
28
- *
29
- * const user = await User.get( wsGateway, '1234' );
30
- */
31
- static get(wsGateway: IWebSocketGateway, id: string): Promise<User>;
32
- /**
33
- * Returns existing Users from server or create a User objects.
34
- *
35
- * const users = await User.getMany( wsGateway, ['1234', '5678'] );
36
- */
37
- static getMany(wsGateway: IWebSocketGateway, ids: string[]): Promise<User[]>;
38
- }
39
- declare interface User extends Record<string, unknown> {
40
- }
41
- export default User;
package/src/version.d.ts DELETED
@@ -1,2 +0,0 @@
1
- declare const _default: "52.1.0";
2
- export default _default;
@@ -1,31 +0,0 @@
1
- import { Emitter } from 'ckeditor5/src/utils.js';
2
- import { ISocket, IWebSocketGateway } from './websocketgateway';
3
- declare const Channel_base: {
4
- new (): Emitter;
5
- prototype: Emitter;
6
- };
7
- /**
8
- * Abstracts Socket.io channels event generation as general Emitter that will fire events for all service events.
9
- *
10
- * Fires two events for each channel message:
11
- * 1. 'all:event:event-name'
12
- * 2. 'event:event-name'
13
- *
14
- * Event without 'all' prefix is not fired for messages that socketIdated from this WebSocket.sessionId.
15
- */
16
- declare class Channel extends Channel_base implements Emitter {
17
- private readonly _channelName;
18
- private readonly _wsGateway;
19
- private readonly _socket;
20
- constructor(_channelName: string, _wsGateway: IWebSocketGateway, _socket: ISocket);
21
- /**
22
- * Removes handlers from socket.
23
- */
24
- remove(): void;
25
- /**
26
- * Returns normalized event name.
27
- */
28
- getEventName(eventName?: string | number, all?: boolean): string;
29
- private _subscribeToChannel;
30
- }
31
- export default Channel;
@@ -1,21 +0,0 @@
1
- /// <reference types="node" />
2
- import Message, { IMessage } from './../../message';
3
- import { IDescriptorBody } from '../../descriptor';
4
- export interface IChannelMessage extends IMessage {
5
- type: number;
6
- socketId: string;
7
- data: Buffer | ArrayBuffer;
8
- }
9
- /**
10
- * Default class for wrapping messages broadcasted by WebSocket Gateway on channels.
11
- */
12
- export default class ChannelMessage extends Message {
13
- readonly type: number;
14
- readonly socketId: string;
15
- readonly data: Buffer | ArrayBuffer;
16
- static readonly DESCRIPTOR_NAME: string;
17
- static readonly DESCRIPTOR: IDescriptorBody;
18
- constructor(type: number, socketId: string, data: Buffer | ArrayBuffer);
19
- toJSON(): IChannelMessage;
20
- static fromJSON(data: IChannelMessage): ChannelMessage;
21
- }
@@ -1,15 +0,0 @@
1
- /// <reference types="node" />
2
- import { Packet as IOPacket } from 'socket.io-parser';
3
- export interface IPacketParserOptions {
4
- flags?: Record<string, unknown>;
5
- rooms?: string[];
6
- except?: string[];
7
- }
8
- export declare type Packet = IOPacket;
9
- export default class PacketParser {
10
- encode(type: number, data: unknown[], id?: number, nsp?: string, options?: IPacketParserOptions): Buffer;
11
- decode(buffer: Buffer): {
12
- packet: Packet;
13
- options: IPacketParserOptions;
14
- };
15
- }
@@ -1,18 +0,0 @@
1
- /// <reference types="node" />
2
- import { IDescriptorBody } from '../../../descriptor';
3
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
4
- export interface IBytesBytesPacketDataMessage extends IPackageDataMessage {
5
- data: Buffer;
6
- data1: Buffer;
7
- }
8
- export default class BytesBytesPacketDataMessage extends PackageDataMessage {
9
- readonly data: Buffer;
10
- readonly data1: Buffer;
11
- static readonly TYPE: number;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(data: Buffer, data1: Buffer);
15
- toJSON(): IBytesBytesPacketDataMessage;
16
- static fromJSON(data: IBytesBytesPacketDataMessage): BytesBytesPacketDataMessage;
17
- static create(data: Buffer, data1: Buffer): BytesBytesPacketDataMessage;
18
- }
@@ -1,18 +0,0 @@
1
- /// <reference types="node" />
2
- import { IDescriptorBody } from '../../../descriptor';
3
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
4
- export interface INumberBytesPacketDataMessage extends IPackageDataMessage {
5
- data: number;
6
- data1: Buffer;
7
- }
8
- export default class NumberBytesPacketDataMessage extends PackageDataMessage {
9
- readonly data: number;
10
- readonly data1: Buffer;
11
- static readonly TYPE: number;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(data: number, data1: Buffer);
15
- toJSON(): INumberBytesPacketDataMessage;
16
- static fromJSON(data: INumberBytesPacketDataMessage): NumberBytesPacketDataMessage;
17
- static create(data: number, data1: Buffer): NumberBytesPacketDataMessage;
18
- }
@@ -1,17 +0,0 @@
1
- import { IDescriptorBody } from '../../../descriptor';
2
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
3
- export interface INumberNumberPacketDataMessage extends IPackageDataMessage {
4
- data: number;
5
- data1: number;
6
- }
7
- export default class NumberNumberPacketDataMessage extends PackageDataMessage {
8
- readonly data: number;
9
- readonly data1: number;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: number, data1: number);
14
- toJSON(): INumberNumberPacketDataMessage;
15
- static fromJSON(data: INumberNumberPacketDataMessage): NumberNumberPacketDataMessage;
16
- static create(data: number, data1: number): NumberNumberPacketDataMessage;
17
- }
@@ -1,17 +0,0 @@
1
- import { IDescriptorBody } from '../../../descriptor';
2
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
3
- export interface INumberObjectPacketDataMessage extends IPackageDataMessage {
4
- data: number;
5
- data1?: string;
6
- }
7
- export default class NumberObjectPacketDataMessage extends PackageDataMessage {
8
- readonly data: number;
9
- readonly data1: Record<string, unknown>;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: number, data1: Record<string, unknown>);
14
- toJSON(): INumberObjectPacketDataMessage;
15
- static fromJSON(data: INumberObjectPacketDataMessage): NumberObjectPacketDataMessage;
16
- static create(data: number, data1: Record<string, unknown>): NumberObjectPacketDataMessage;
17
- }
@@ -1,17 +0,0 @@
1
- import { IDescriptorBody } from '../../../descriptor';
2
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
3
- export interface INumberStringPacketDataMessage extends IPackageDataMessage {
4
- data: number;
5
- data1: string;
6
- }
7
- export default class NumberStringPacketDataMessage extends PackageDataMessage {
8
- readonly data: number;
9
- readonly data1: string;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: number, data1: string);
14
- toJSON(): INumberStringPacketDataMessage;
15
- static fromJSON(data: INumberStringPacketDataMessage): NumberStringPacketDataMessage;
16
- static create(data: number, data1: string): NumberStringPacketDataMessage;
17
- }
@@ -1,18 +0,0 @@
1
- /// <reference types="node" />
2
- import { IDescriptorBody } from '../../../descriptor';
3
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
4
- export interface IObjectBufferPacketDataMessage extends IPackageDataMessage {
5
- data?: string;
6
- data1: Buffer;
7
- }
8
- export default class ObjectBufferPacketDataMessage extends PackageDataMessage {
9
- readonly data: Record<string, unknown>;
10
- readonly data1: Buffer;
11
- static readonly TYPE: number;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(data: Record<string, unknown>, data1: Buffer);
15
- toJSON(): IObjectBufferPacketDataMessage;
16
- static fromJSON(data: IObjectBufferPacketDataMessage): ObjectBufferPacketDataMessage;
17
- static create(data: Record<string, unknown>, data1: Buffer): ObjectBufferPacketDataMessage;
18
- }
@@ -1,17 +0,0 @@
1
- import { IDescriptorBody } from '../../../descriptor';
2
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
3
- export interface IObjectObjectPacketDataMessage extends IPackageDataMessage {
4
- data?: string;
5
- data1?: string;
6
- }
7
- export default class ObjectObjectPacketDataMessage extends PackageDataMessage {
8
- readonly data: Record<string, unknown>;
9
- readonly data1: Record<string, unknown>;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: Record<string, unknown>, data1: Record<string, unknown>);
14
- toJSON(): IObjectObjectPacketDataMessage;
15
- static fromJSON(data: IObjectObjectPacketDataMessage): ObjectObjectPacketDataMessage;
16
- static create(data: Record<string, unknown>, data1: Record<string, unknown>): ObjectObjectPacketDataMessage;
17
- }
@@ -1,16 +0,0 @@
1
- import Message, { IMessage, IMessageConstructor } from '../../../message';
2
- export interface IPackageDataMessageConstructor extends IMessageConstructor {
3
- new (...args: unknown[]): PackageDataMessage;
4
- readonly TYPE: number;
5
- create(data: unknown, data1: unknown): PackageDataMessage;
6
- }
7
- export interface IPackageDataMessage extends IMessage {
8
- readonly data?: unknown;
9
- readonly data1?: unknown;
10
- }
11
- export default abstract class PackageDataMessage extends Message {
12
- readonly data: unknown;
13
- readonly data1: unknown;
14
- ['constructor']: IPackageDataMessageConstructor;
15
- static create(data: unknown, data1: unknown): PackageDataMessage;
16
- }
@@ -1,31 +0,0 @@
1
- /// <reference types="node" />
2
- import Message, { IMessage } from './../../../message';
3
- import PacketOptionsMessage from './packetoptionsmessage';
4
- import { IPacketParserOptions, Packet } from '../packetparser';
5
- import PackageDataMessage from './packagedatamessage';
6
- import { IDescriptorBody } from '../../../descriptor';
7
- export interface IPacketMessage extends IMessage {
8
- type: number;
9
- id?: number;
10
- nsp?: string;
11
- data: Buffer;
12
- options?: Buffer;
13
- }
14
- export default class PacketMessage extends Message {
15
- readonly type: number;
16
- readonly data: PackageDataMessage;
17
- readonly id?: number | undefined;
18
- readonly nsp: string;
19
- readonly options: PacketOptionsMessage;
20
- static readonly TYPE: number;
21
- static readonly DESCRIPTOR_NAME: string;
22
- static readonly DESCRIPTOR: IDescriptorBody;
23
- constructor(type: number, data: PackageDataMessage, id?: number | undefined, nsp?: string, options?: PacketOptionsMessage);
24
- get packetData(): unknown[];
25
- toJSON(): IPacketMessage;
26
- static fromJSON(data: IPacketMessage): PacketMessage;
27
- /**
28
- * Creates a PacketMessage.
29
- */
30
- static create(packet: Packet, options?: IPacketParserOptions): PacketMessage;
31
- }
@@ -1,18 +0,0 @@
1
- import Message, { IMessage } from './../../../message';
2
- import { IDescriptorBody } from '../../../descriptor';
3
- export interface IPacketOptionsMessage extends IMessage {
4
- flags?: string;
5
- rooms?: string[];
6
- except?: string[];
7
- }
8
- export default class PacketOptionsMessage extends Message {
9
- readonly flags?: Record<string, unknown> | undefined;
10
- readonly rooms: string[];
11
- readonly except: string[];
12
- static readonly TYPE: number;
13
- static readonly DESCRIPTOR_NAME: string;
14
- static readonly DESCRIPTOR: IDescriptorBody;
15
- constructor(flags?: Record<string, unknown> | undefined, rooms?: string[], except?: string[]);
16
- toJSON(): IPacketOptionsMessage;
17
- static fromJSON(data: IPacketOptionsMessage): PacketOptionsMessage;
18
- }
@@ -1,18 +0,0 @@
1
- /// <reference types="node" />
2
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
3
- import { IDescriptorBody } from '../../../descriptor';
4
- export interface IStringBytesPacketDataMessage extends IPackageDataMessage {
5
- data: string;
6
- data1: Buffer;
7
- }
8
- export default class StringBytesPacketDataMessage extends PackageDataMessage {
9
- readonly data: string;
10
- readonly data1: Buffer;
11
- static readonly TYPE: number;
12
- static readonly DESCRIPTOR_NAME: string;
13
- static readonly DESCRIPTOR: IDescriptorBody;
14
- constructor(data: string, data1: Buffer);
15
- toJSON(): IStringBytesPacketDataMessage;
16
- static fromJSON(data: IStringBytesPacketDataMessage): StringBytesPacketDataMessage;
17
- static create(data: string, data1: Buffer): StringBytesPacketDataMessage;
18
- }
@@ -1,17 +0,0 @@
1
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
2
- import { IDescriptorBody } from '../../../descriptor';
3
- export interface IStringNumberPacketDataMessage extends IPackageDataMessage {
4
- data: string;
5
- data1: number;
6
- }
7
- export default class StringNumberPacketDataMessage extends PackageDataMessage {
8
- readonly data: string;
9
- readonly data1: number;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: string, data1: number);
14
- toJSON(): IStringNumberPacketDataMessage;
15
- static fromJSON(data: IStringNumberPacketDataMessage): StringNumberPacketDataMessage;
16
- static create(data: string, data1: number): StringNumberPacketDataMessage;
17
- }
@@ -1,17 +0,0 @@
1
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
2
- import { IDescriptorBody } from '../../../descriptor';
3
- export interface IStringObjectPacketDataMessage extends IPackageDataMessage {
4
- data: string;
5
- data1?: string;
6
- }
7
- export default class StringObjectPacketDataMessage extends PackageDataMessage {
8
- readonly data: string;
9
- readonly data1: Record<string, unknown>;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: string, data1: Record<string, unknown>);
14
- toJSON(): IStringObjectPacketDataMessage;
15
- static fromJSON(data: IStringObjectPacketDataMessage): StringObjectPacketDataMessage;
16
- static create(data: string, data1: Record<string, unknown>): StringObjectPacketDataMessage;
17
- }
@@ -1,17 +0,0 @@
1
- import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
2
- import { IDescriptorBody } from '../../../descriptor';
3
- export interface IStringStringPacketDataMessage extends IPackageDataMessage {
4
- data: string;
5
- data1: string;
6
- }
7
- export default class StringStringPacketDataMessage extends PackageDataMessage {
8
- readonly data: string;
9
- readonly data1: string;
10
- static readonly TYPE: number;
11
- static readonly DESCRIPTOR_NAME: string;
12
- static readonly DESCRIPTOR: IDescriptorBody;
13
- constructor(data: string, data1: string);
14
- toJSON(): IStringStringPacketDataMessage;
15
- static fromJSON(data: IStringStringPacketDataMessage): StringStringPacketDataMessage;
16
- static create(data: string, data1: string): StringStringPacketDataMessage;
17
- }
@@ -1,14 +0,0 @@
1
- /// <reference types="node" />
2
- import { Decoder as IODecoder, Encoder as IOEncoder, Packet, PacketType } from 'socket.io-parser';
3
- import PacketParser from './packetparser';
4
- export declare const ENCODED_TYPES: PacketType[];
5
- export declare class Encoder extends IOEncoder {
6
- private readonly _packetParser;
7
- constructor(_packetParser?: PacketParser);
8
- encode(packet: Packet): unknown[];
9
- }
10
- export declare class Decoder extends IODecoder {
11
- private readonly _packetParser;
12
- constructor(_packetParser?: PacketParser);
13
- add(obj: Buffer | unknown): void;
14
- }
@@ -1,27 +0,0 @@
1
- /// <reference types="node" />
2
- export declare enum MessageDataTypes {
3
- BUFFER = 1,
4
- STRING = 2,
5
- NUMBER = 3,
6
- OBJECT = 4
7
- }
8
- export default class ParserUtils {
9
- /**
10
- * Generates packet type code (number) from types.
11
- *
12
- * Algorithm:
13
- * INPUT: [STRING, OBJECT, BUFFER]
14
- * OUTPUT: 241
15
- * OUTPUT = INPUT[0] * 100 + INPUT[1] * 10 + INPUT[2] * 1
16
- */
17
- static getPacketType(...types: MessageDataTypes[]): number;
18
- /**
19
- * Returns name of type which is supported by Parser.
20
- */
21
- static getType(obj: unknown): MessageDataTypes;
22
- /**
23
- * Returns information does object is a Buffer
24
- */
25
- static isBuffer(obj: unknown): obj is Buffer;
26
- private static _isBufferView;
27
- }
@@ -1,20 +0,0 @@
1
- import CKEditorCloudServicesError from '../ckeditorcloudserviceserror';
2
- import CKEditorCloudServicesServerError from '../ckeditorcloudservicesservererror';
3
- import { IMessage } from '../message';
4
- import WebSocketGateway from './websocketgateway';
5
- interface IWebSocketRequest<TResponse extends IMessage> {
6
- response(response: TResponse): void;
7
- error(error: CKEditorCloudServicesError | CKEditorCloudServicesServerError): void;
8
- }
9
- export default class WebSocketGatewayRequestsManager {
10
- private readonly _context;
11
- private readonly _requests;
12
- constructor(_context: WebSocketGateway);
13
- send<TResponse extends IMessage>(sendFunction: (req: IWebSocketRequest<TResponse>) => void, timeoutMs?: number): Promise<TResponse>;
14
- errorAll(error: CKEditorCloudServicesError): void;
15
- waitForAllRequests(time?: number): Promise<void>;
16
- private _createRequest;
17
- private _finishRequest;
18
- private _waitForRequests;
19
- }
20
- export {};