@ckeditor/ckeditor-cloud-services-collaboration 0.0.0-internal-20251222.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 (111) hide show
  1. package/LICENSE.md +30 -0
  2. package/README.md +21 -0
  3. package/dist/ckeditorcloudserviceserror.d.ts +11 -0
  4. package/dist/ckeditorcloudservicesservererror.d.ts +18 -0
  5. package/dist/collaborativeeditingservice/collaborativeeditingservice.d.ts +131 -0
  6. package/dist/collaborativeeditingservice/descriptors/operationmetadatadescriptor.d.ts +21 -0
  7. package/dist/collaborativeeditingservice/helpers/operationmetadatahelpers.d.ts +14 -0
  8. package/dist/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.d.ts +28 -0
  9. package/dist/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.d.ts +22 -0
  10. package/dist/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.d.ts +42 -0
  11. package/dist/collaborativeeditingservice/messages/getdocumentdetailsmessage.d.ts +19 -0
  12. package/dist/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.d.ts +72 -0
  13. package/dist/collaborativeeditingservice/responses/collaborativeeditingresponse.d.ts +55 -0
  14. package/dist/collaborativeeditingservice/responses/getdocumentdetailsresponse.d.ts +31 -0
  15. package/dist/comments-v2/commentsservice.d.ts +75 -0
  16. package/dist/comments-v2/descriptors/commentdescriptor.d.ts +26 -0
  17. package/dist/comments-v2/descriptors/commentsthreaddescriptor.d.ts +34 -0
  18. package/dist/comments-v2/descriptors/commentthreadaddedcomment.d.ts +18 -0
  19. package/dist/comments-v2/messages/addcommentmessage.d.ts +33 -0
  20. package/dist/comments-v2/messages/comment-threads/addcommentthreadmessage.d.ts +35 -0
  21. package/dist/comments-v2/messages/comment-threads/reopencommentthreadmessage.d.ts +20 -0
  22. package/dist/comments-v2/messages/comment-threads/resolvecommentthreadmessage.d.ts +24 -0
  23. package/dist/comments-v2/messages/comment-threads/updatecommentthreadmessage.d.ts +26 -0
  24. package/dist/comments-v2/messages/connectmessage.d.ts +18 -0
  25. package/dist/comments-v2/messages/getcommentthreadmessage.d.ts +20 -0
  26. package/dist/comments-v2/messages/getdocumentthreadsmessage.d.ts +18 -0
  27. package/dist/comments-v2/messages/removecommentmessage.d.ts +22 -0
  28. package/dist/comments-v2/messages/removecommentthreadmessage.d.ts +20 -0
  29. package/dist/comments-v2/messages/updatecommentmessage.d.ts +31 -0
  30. package/dist/comments-v2/responses/addcommentresponse.d.ts +20 -0
  31. package/dist/comments-v2/responses/comment-threads/addcommentthreadresponse.d.ts +25 -0
  32. package/dist/comments-v2/responses/comment-threads/resolvecommentthreadresponse.d.ts +22 -0
  33. package/dist/comments-v2/responses/connectresponse.d.ts +22 -0
  34. package/dist/comments-v2/responses/getcommentthreadresponse.d.ts +36 -0
  35. package/dist/comments-v2/responses/getdocumentthreadsresponse.d.ts +20 -0
  36. package/dist/compiledmessages.d.ts +6 -0
  37. package/dist/descriptor.d.ts +16 -0
  38. package/dist/descriptors/keyvaluedescriptor.d.ts +8 -0
  39. package/dist/editor/editorservice.d.ts +14 -0
  40. package/dist/editor/messages/iseditorbundleuploadedmessage.d.ts +18 -0
  41. package/dist/editor/responses/iseditorbundleuploadedresponse.d.ts +16 -0
  42. package/dist/errors/ServiceNotConnectedError.d.ts +7 -0
  43. package/dist/index.d.ts +68 -0
  44. package/dist/message.d.ts +20 -0
  45. package/dist/messagescompressor.d.ts +19 -0
  46. package/dist/messagesmapper.d.ts +12 -0
  47. package/dist/revision-history/descriptors/revisiondescriptor.d.ts +45 -0
  48. package/dist/revision-history/messages/revisionhistoryconnectmessage.d.ts +18 -0
  49. package/dist/revision-history/messages/revisionhistorygetrevisionmessage.d.ts +20 -0
  50. package/dist/revision-history/messages/revisionhistoryreconnectmessage.d.ts +20 -0
  51. package/dist/revision-history/messages/revisionhistoryupdaterevisionsmessage.d.ts +44 -0
  52. package/dist/revision-history/responses/revisionhistoryconnectresponse.d.ts +33 -0
  53. package/dist/revision-history/responses/revisionhistorygetrevisionresponse.d.ts +33 -0
  54. package/dist/revision-history/responses/revisionhistoryupdaterevisionsresponse.d.ts +16 -0
  55. package/dist/revision-history/revision.d.ts +18 -0
  56. package/dist/revision-history/revisionhistoryservice.d.ts +78 -0
  57. package/dist/services-content.css +3 -0
  58. package/dist/services-editor.css +3 -0
  59. package/dist/services.css +3 -0
  60. package/dist/services.d.ts +19 -0
  61. package/dist/services.js +67 -0
  62. package/dist/services.js.map +1 -0
  63. package/dist/sessions/descriptors/sessiondescriptor.d.ts +8 -0
  64. package/dist/sessions/messages/sessionsconnectmessage.d.ts +20 -0
  65. package/dist/sessions/messages/socketconnectmessage.d.ts +24 -0
  66. package/dist/sessions/messages/socketdisconnectmessage.d.ts +18 -0
  67. package/dist/sessions/responses/sessionsconnectresponse.d.ts +24 -0
  68. package/dist/sessions/sessioncollection.d.ts +43 -0
  69. package/dist/sessions/sessions.d.ts +16 -0
  70. package/dist/track-changes/descriptors/suggestiondescriptor.d.ts +28 -0
  71. package/dist/track-changes/messages/addsuggestionmessage.d.ts +28 -0
  72. package/dist/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts +22 -0
  73. package/dist/track-changes/messages/connectmessage.d.ts +18 -0
  74. package/dist/track-changes/messages/getallsuggestionsmessage.d.ts +18 -0
  75. package/dist/track-changes/messages/getsuggestionmessage.d.ts +20 -0
  76. package/dist/track-changes/messages/updatesuggestionmessage.d.ts +28 -0
  77. package/dist/track-changes/responses/addsuggestionresponse.d.ts +30 -0
  78. package/dist/track-changes/responses/connectresponse.d.ts +22 -0
  79. package/dist/track-changes/responses/getallsuggestionsresponse.d.ts +20 -0
  80. package/dist/track-changes/responses/getsuggestionresponse.d.ts +30 -0
  81. package/dist/track-changes/trackchangesservice.d.ts +65 -0
  82. package/dist/types.d.ts +10 -0
  83. package/dist/users/descriptors/userdescriptor.d.ts +8 -0
  84. package/dist/users/messages/getmanyusersmessage.d.ts +18 -0
  85. package/dist/users/messages/getusermessage.d.ts +18 -0
  86. package/dist/users/responses/getmanyusersresponse.d.ts +16 -0
  87. package/dist/users/responses/getuserresponse.d.ts +16 -0
  88. package/dist/users/user.d.ts +44 -0
  89. package/dist/version.d.ts +5 -0
  90. package/dist/websocketgateway/channel.d.ts +34 -0
  91. package/dist/websocketgateway/messages/channelmessage.d.ts +25 -0
  92. package/dist/websocketgateway/parser/packetparser.d.ts +19 -0
  93. package/dist/websocketgateway/parser/packets/bytesbytespacketdatamessage.d.ts +22 -0
  94. package/dist/websocketgateway/parser/packets/numberbytespacketdatamessage.d.ts +22 -0
  95. package/dist/websocketgateway/parser/packets/numbernumberpacketdatamessag.d.ts +20 -0
  96. package/dist/websocketgateway/parser/packets/numberobjectpacketdatamessage.d.ts +20 -0
  97. package/dist/websocketgateway/parser/packets/numberstringpacketdatamessag.d.ts +20 -0
  98. package/dist/websocketgateway/parser/packets/objectbufferpacketdatamessage.d.ts +22 -0
  99. package/dist/websocketgateway/parser/packets/objectobjectpacketdatamessage.d.ts +20 -0
  100. package/dist/websocketgateway/parser/packets/packagedatamessage.d.ts +19 -0
  101. package/dist/websocketgateway/parser/packets/packetmessage.d.ts +35 -0
  102. package/dist/websocketgateway/parser/packets/packetoptionsmessage.d.ts +21 -0
  103. package/dist/websocketgateway/parser/packets/stringbytespacketdatamessage.d.ts +22 -0
  104. package/dist/websocketgateway/parser/packets/stringnumberpacketdatamessage.d.ts +20 -0
  105. package/dist/websocketgateway/parser/packets/stringobjectpacketdatamessage.d.ts +20 -0
  106. package/dist/websocketgateway/parser/packets/stringstringpacketdatamessage.d.ts +20 -0
  107. package/dist/websocketgateway/parser/parser.d.ts +18 -0
  108. package/dist/websocketgateway/parser/parserutils.d.ts +33 -0
  109. package/dist/websocketgateway/requestsmanager.d.ts +23 -0
  110. package/dist/websocketgateway/websocketgateway.d.ts +169 -0
  111. package/package.json +42 -0
@@ -0,0 +1,34 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { type Emitter } from '@ckeditor/ckeditor5-utils';
5
+ import type { ISocket, IWebSocketGateway } from './websocketgateway';
6
+ declare const Channel_base: {
7
+ new (): Emitter;
8
+ prototype: Emitter;
9
+ };
10
+ /**
11
+ * Abstracts Socket.io channels event generation as general Emitter that will fire events for all service events.
12
+ *
13
+ * Fires two events for each channel message:
14
+ * 1. 'all:event:event-name'
15
+ * 2. 'event:event-name'
16
+ *
17
+ * Event without 'all' prefix is not fired for messages that socketIdated from this WebSocket.sessionId.
18
+ */
19
+ declare class Channel extends /* #__PURE__ -- @preserve */ Channel_base implements Emitter {
20
+ private readonly _channelName;
21
+ private readonly _wsGateway;
22
+ private readonly _socket;
23
+ constructor(_channelName: string, _wsGateway: IWebSocketGateway, _socket: ISocket);
24
+ /**
25
+ * Removes handlers from socket.
26
+ */
27
+ remove(): void;
28
+ /**
29
+ * Returns normalized event name.
30
+ */
31
+ getEventName(eventName?: string | number, all?: boolean): string;
32
+ private _subscribeToChannel;
33
+ }
34
+ export default Channel;
@@ -0,0 +1,25 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import Message, { IMessage } from './../../message';
7
+ import { IDescriptorBody } from '../../descriptor';
8
+ export interface IChannelMessage extends IMessage {
9
+ type: number;
10
+ socketId: string;
11
+ data: Buffer | ArrayBuffer;
12
+ }
13
+ /**
14
+ * Default class for wrapping messages broadcasted by WebSocket Gateway on channels.
15
+ */
16
+ export default class ChannelMessage extends Message {
17
+ readonly type: number;
18
+ readonly socketId: string;
19
+ readonly data: Buffer | ArrayBuffer;
20
+ static readonly DESCRIPTOR_NAME: string;
21
+ static readonly DESCRIPTOR: IDescriptorBody;
22
+ constructor(type: number, socketId: string, data: Buffer | ArrayBuffer);
23
+ toJSON(): IChannelMessage;
24
+ static fromJSON(data: IChannelMessage): ChannelMessage;
25
+ }
@@ -0,0 +1,19 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import { Packet as IOPacket } from 'socket.io-parser';
7
+ export interface IPacketParserOptions {
8
+ flags?: Record<string, unknown>;
9
+ rooms?: string[];
10
+ except?: string[];
11
+ }
12
+ export type Packet = IOPacket;
13
+ export default class PacketParser {
14
+ encode(type: number, data: unknown[], id?: number, nsp?: string, options?: IPacketParserOptions): Buffer;
15
+ decode(buffer: Buffer): {
16
+ packet: Packet;
17
+ options: IPacketParserOptions;
18
+ };
19
+ }
@@ -0,0 +1,22 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import { IDescriptorBody } from '../../../descriptor';
7
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
8
+ export interface IBytesBytesPacketDataMessage extends IPackageDataMessage {
9
+ data: Buffer;
10
+ data1: Buffer;
11
+ }
12
+ export default class BytesBytesPacketDataMessage extends PackageDataMessage {
13
+ readonly data: Buffer;
14
+ readonly data1: Buffer;
15
+ static readonly TYPE: number;
16
+ static readonly DESCRIPTOR_NAME: string;
17
+ static readonly DESCRIPTOR: IDescriptorBody;
18
+ constructor(data: Buffer, data1: Buffer);
19
+ toJSON(): IBytesBytesPacketDataMessage;
20
+ static fromJSON(data: IBytesBytesPacketDataMessage): BytesBytesPacketDataMessage;
21
+ static create(data: Buffer, data1: Buffer): BytesBytesPacketDataMessage;
22
+ }
@@ -0,0 +1,22 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import { IDescriptorBody } from '../../../descriptor';
7
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
8
+ export interface INumberBytesPacketDataMessage extends IPackageDataMessage {
9
+ data: number;
10
+ data1: Buffer;
11
+ }
12
+ export default class NumberBytesPacketDataMessage extends PackageDataMessage {
13
+ readonly data: number;
14
+ readonly data1: Buffer;
15
+ static readonly TYPE: number;
16
+ static readonly DESCRIPTOR_NAME: string;
17
+ static readonly DESCRIPTOR: IDescriptorBody;
18
+ constructor(data: number, data1: Buffer);
19
+ toJSON(): INumberBytesPacketDataMessage;
20
+ static fromJSON(data: INumberBytesPacketDataMessage): NumberBytesPacketDataMessage;
21
+ static create(data: number, data1: Buffer): NumberBytesPacketDataMessage;
22
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { IDescriptorBody } from '../../../descriptor';
5
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
6
+ export interface INumberNumberPacketDataMessage extends IPackageDataMessage {
7
+ data: number;
8
+ data1: number;
9
+ }
10
+ export default class NumberNumberPacketDataMessage extends PackageDataMessage {
11
+ readonly data: number;
12
+ readonly data1: number;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: number, data1: number);
17
+ toJSON(): INumberNumberPacketDataMessage;
18
+ static fromJSON(data: INumberNumberPacketDataMessage): NumberNumberPacketDataMessage;
19
+ static create(data: number, data1: number): NumberNumberPacketDataMessage;
20
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { IDescriptorBody } from '../../../descriptor';
5
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
6
+ export interface INumberObjectPacketDataMessage extends IPackageDataMessage {
7
+ data: number;
8
+ data1?: string;
9
+ }
10
+ export default class NumberObjectPacketDataMessage extends PackageDataMessage {
11
+ readonly data: number;
12
+ readonly data1: Record<string, unknown>;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: number, data1: Record<string, unknown>);
17
+ toJSON(): INumberObjectPacketDataMessage;
18
+ static fromJSON(data: INumberObjectPacketDataMessage): NumberObjectPacketDataMessage;
19
+ static create(data: number, data1: Record<string, unknown>): NumberObjectPacketDataMessage;
20
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { IDescriptorBody } from '../../../descriptor';
5
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
6
+ export interface INumberStringPacketDataMessage extends IPackageDataMessage {
7
+ data: number;
8
+ data1: string;
9
+ }
10
+ export default class NumberStringPacketDataMessage extends PackageDataMessage {
11
+ readonly data: number;
12
+ readonly data1: string;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: number, data1: string);
17
+ toJSON(): INumberStringPacketDataMessage;
18
+ static fromJSON(data: INumberStringPacketDataMessage): NumberStringPacketDataMessage;
19
+ static create(data: number, data1: string): NumberStringPacketDataMessage;
20
+ }
@@ -0,0 +1,22 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import { IDescriptorBody } from '../../../descriptor';
7
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
8
+ export interface IObjectBufferPacketDataMessage extends IPackageDataMessage {
9
+ data?: string;
10
+ data1: Buffer;
11
+ }
12
+ export default class ObjectBufferPacketDataMessage extends PackageDataMessage {
13
+ readonly data: Record<string, unknown>;
14
+ readonly data1: Buffer;
15
+ static readonly TYPE: number;
16
+ static readonly DESCRIPTOR_NAME: string;
17
+ static readonly DESCRIPTOR: IDescriptorBody;
18
+ constructor(data: Record<string, unknown>, data1: Buffer);
19
+ toJSON(): IObjectBufferPacketDataMessage;
20
+ static fromJSON(data: IObjectBufferPacketDataMessage): ObjectBufferPacketDataMessage;
21
+ static create(data: Record<string, unknown>, data1: Buffer): ObjectBufferPacketDataMessage;
22
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { IDescriptorBody } from '../../../descriptor';
5
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
6
+ export interface IObjectObjectPacketDataMessage extends IPackageDataMessage {
7
+ data?: string;
8
+ data1?: string;
9
+ }
10
+ export default class ObjectObjectPacketDataMessage extends PackageDataMessage {
11
+ readonly data: Record<string, unknown>;
12
+ readonly data1: Record<string, unknown>;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: Record<string, unknown>, data1: Record<string, unknown>);
17
+ toJSON(): IObjectObjectPacketDataMessage;
18
+ static fromJSON(data: IObjectObjectPacketDataMessage): ObjectObjectPacketDataMessage;
19
+ static create(data: Record<string, unknown>, data1: Record<string, unknown>): ObjectObjectPacketDataMessage;
20
+ }
@@ -0,0 +1,19 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import Message, { IMessage, IMessageConstructor } from '../../../message';
5
+ export interface IPackageDataMessageConstructor extends IMessageConstructor {
6
+ new (...args: unknown[]): PackageDataMessage;
7
+ readonly TYPE: number;
8
+ create(data: unknown, data1: unknown): PackageDataMessage;
9
+ }
10
+ export interface IPackageDataMessage extends IMessage {
11
+ readonly data?: unknown;
12
+ readonly data1?: unknown;
13
+ }
14
+ export default abstract class PackageDataMessage extends Message {
15
+ readonly data: unknown;
16
+ readonly data1: unknown;
17
+ ['constructor']: IPackageDataMessageConstructor;
18
+ static create(data: unknown, data1: unknown): PackageDataMessage;
19
+ }
@@ -0,0 +1,35 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import Message, { IMessage } from './../../../message';
7
+ import PacketOptionsMessage from './packetoptionsmessage';
8
+ import { IPacketParserOptions, Packet } from '../packetparser';
9
+ import PackageDataMessage from './packagedatamessage';
10
+ import { IDescriptorBody } from '../../../descriptor';
11
+ export interface IPacketMessage extends IMessage {
12
+ type: number;
13
+ id?: number;
14
+ nsp?: string;
15
+ data: Buffer;
16
+ options?: Buffer;
17
+ }
18
+ export default class PacketMessage extends Message {
19
+ readonly type: number;
20
+ readonly data: PackageDataMessage;
21
+ readonly id?: number | undefined;
22
+ readonly nsp: string;
23
+ readonly options: PacketOptionsMessage;
24
+ static readonly TYPE: number;
25
+ static readonly DESCRIPTOR_NAME: string;
26
+ static readonly DESCRIPTOR: IDescriptorBody;
27
+ constructor(type: number, data: PackageDataMessage, id?: number | undefined, nsp?: string, options?: PacketOptionsMessage);
28
+ get packetData(): unknown[];
29
+ toJSON(): IPacketMessage;
30
+ static fromJSON(data: IPacketMessage): PacketMessage;
31
+ /**
32
+ * Creates a PacketMessage.
33
+ */
34
+ static create(packet: Packet, options?: IPacketParserOptions): PacketMessage;
35
+ }
@@ -0,0 +1,21 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import Message, { IMessage } from './../../../message';
5
+ import { IDescriptorBody } from '../../../descriptor';
6
+ export interface IPacketOptionsMessage extends IMessage {
7
+ flags?: string;
8
+ rooms?: string[];
9
+ except?: string[];
10
+ }
11
+ export default class PacketOptionsMessage extends Message {
12
+ readonly flags?: Record<string, unknown> | undefined;
13
+ readonly rooms: string[];
14
+ readonly except: string[];
15
+ static readonly TYPE: number;
16
+ static readonly DESCRIPTOR_NAME: string;
17
+ static readonly DESCRIPTOR: IDescriptorBody;
18
+ constructor(flags?: Record<string, unknown> | undefined, rooms?: string[], except?: string[]);
19
+ toJSON(): IPacketOptionsMessage;
20
+ static fromJSON(data: IPacketOptionsMessage): PacketOptionsMessage;
21
+ }
@@ -0,0 +1,22 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
7
+ import { IDescriptorBody } from '../../../descriptor';
8
+ export interface IStringBytesPacketDataMessage extends IPackageDataMessage {
9
+ data: string;
10
+ data1: Buffer;
11
+ }
12
+ export default class StringBytesPacketDataMessage extends PackageDataMessage {
13
+ readonly data: string;
14
+ readonly data1: Buffer;
15
+ static readonly TYPE: number;
16
+ static readonly DESCRIPTOR_NAME: string;
17
+ static readonly DESCRIPTOR: IDescriptorBody;
18
+ constructor(data: string, data1: Buffer);
19
+ toJSON(): IStringBytesPacketDataMessage;
20
+ static fromJSON(data: IStringBytesPacketDataMessage): StringBytesPacketDataMessage;
21
+ static create(data: string, data1: Buffer): StringBytesPacketDataMessage;
22
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
5
+ import { IDescriptorBody } from '../../../descriptor';
6
+ export interface IStringNumberPacketDataMessage extends IPackageDataMessage {
7
+ data: string;
8
+ data1: number;
9
+ }
10
+ export default class StringNumberPacketDataMessage extends PackageDataMessage {
11
+ readonly data: string;
12
+ readonly data1: number;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: string, data1: number);
17
+ toJSON(): IStringNumberPacketDataMessage;
18
+ static fromJSON(data: IStringNumberPacketDataMessage): StringNumberPacketDataMessage;
19
+ static create(data: string, data1: number): StringNumberPacketDataMessage;
20
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
5
+ import { IDescriptorBody } from '../../../descriptor';
6
+ export interface IStringObjectPacketDataMessage extends IPackageDataMessage {
7
+ data: string;
8
+ data1?: string;
9
+ }
10
+ export default class StringObjectPacketDataMessage extends PackageDataMessage {
11
+ readonly data: string;
12
+ readonly data1: Record<string, unknown>;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: string, data1: Record<string, unknown>);
17
+ toJSON(): IStringObjectPacketDataMessage;
18
+ static fromJSON(data: IStringObjectPacketDataMessage): StringObjectPacketDataMessage;
19
+ static create(data: string, data1: Record<string, unknown>): StringObjectPacketDataMessage;
20
+ }
@@ -0,0 +1,20 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import PackageDataMessage, { IPackageDataMessage } from './packagedatamessage';
5
+ import { IDescriptorBody } from '../../../descriptor';
6
+ export interface IStringStringPacketDataMessage extends IPackageDataMessage {
7
+ data: string;
8
+ data1: string;
9
+ }
10
+ export default class StringStringPacketDataMessage extends PackageDataMessage {
11
+ readonly data: string;
12
+ readonly data1: string;
13
+ static readonly TYPE: number;
14
+ static readonly DESCRIPTOR_NAME: string;
15
+ static readonly DESCRIPTOR: IDescriptorBody;
16
+ constructor(data: string, data1: string);
17
+ toJSON(): IStringStringPacketDataMessage;
18
+ static fromJSON(data: IStringStringPacketDataMessage): StringStringPacketDataMessage;
19
+ static create(data: string, data1: string): StringStringPacketDataMessage;
20
+ }
@@ -0,0 +1,18 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ import { Decoder as IODecoder, Encoder as IOEncoder, Packet, PacketType } from 'socket.io-parser';
7
+ import PacketParser from './packetparser';
8
+ export declare const ENCODED_TYPES: PacketType[];
9
+ export declare class Encoder extends IOEncoder {
10
+ private readonly _packetParser;
11
+ constructor(packetParser?: PacketParser);
12
+ encode(packet: Packet): unknown[];
13
+ }
14
+ export declare class Decoder extends IODecoder {
15
+ private readonly _packetParser;
16
+ constructor(packetParser?: PacketParser);
17
+ add(obj: Buffer | unknown): void;
18
+ }
@@ -0,0 +1,33 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ /// <reference types="node" />
5
+ /// <reference types="node" />
6
+ export declare const MessageDataTypes: {
7
+ readonly BUFFER: 1;
8
+ readonly STRING: 2;
9
+ readonly NUMBER: 3;
10
+ readonly OBJECT: 4;
11
+ };
12
+ export type IMessageDataTypes = typeof MessageDataTypes;
13
+ export type MessageDataType = IMessageDataTypes[keyof IMessageDataTypes];
14
+ export default class ParserUtils {
15
+ /**
16
+ * Generates packet type code (number) from types.
17
+ *
18
+ * Algorithm:
19
+ * INPUT: [STRING, OBJECT, BUFFER]
20
+ * OUTPUT: 241
21
+ * OUTPUT = INPUT[0] * 100 + INPUT[1] * 10 + INPUT[2] * 1
22
+ */
23
+ static getPacketType(...types: MessageDataType[]): number;
24
+ /**
25
+ * Returns name of type which is supported by Parser.
26
+ */
27
+ static getType(obj: unknown): MessageDataType;
28
+ /**
29
+ * Returns information does object is a Buffer
30
+ */
31
+ static isBuffer(obj: unknown): obj is Buffer;
32
+ private static _isBufferView;
33
+ }
@@ -0,0 +1,23 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import CKEditorCloudServicesError from '../ckeditorcloudserviceserror';
5
+ import CKEditorCloudServicesServerError from '../ckeditorcloudservicesservererror';
6
+ import { IMessage } from '../message';
7
+ import WebSocketGateway from './websocketgateway';
8
+ interface IWebSocketRequest<TResponse extends IMessage> {
9
+ response(response: TResponse): void;
10
+ error(error: CKEditorCloudServicesError | CKEditorCloudServicesServerError): void;
11
+ }
12
+ export default class WebSocketGatewayRequestsManager {
13
+ private readonly _context;
14
+ private readonly _requests;
15
+ constructor(_context: WebSocketGateway);
16
+ send<TResponse extends IMessage>(sendFunction: (req: IWebSocketRequest<TResponse>) => void, timeoutMs?: number): Promise<TResponse>;
17
+ errorAll(error: CKEditorCloudServicesError): void;
18
+ waitForAllRequests(time?: number): Promise<void>;
19
+ private _createRequest;
20
+ private _finishRequest;
21
+ private _waitForRequests;
22
+ }
23
+ export {};
@@ -0,0 +1,169 @@
1
+ /*
2
+ Copyright (c), CKSource Holding sp. z o.o. All rights reserved.
3
+ */
4
+ import { ManagerOptions, Socket } from 'socket.io-client';
5
+ import { Decoder as IODecoder, Encoder as IOEncoder } from 'socket.io-parser';
6
+ import { Emitter } from '@ckeditor/ckeditor5-utils';
7
+ import Channel from './channel';
8
+ import { IToken } from '../types';
9
+ import User from './../users/user';
10
+ import { IMessage } from '../message';
11
+ export declare const WEB_SOCKET_GATEWAY_STATES: {
12
+ readonly DISCONNECTED: "disconnected";
13
+ readonly CONNECTING: "connecting";
14
+ readonly CONNECTED: "connected";
15
+ };
16
+ export type IWebSocketGatewayStates = typeof WEB_SOCKET_GATEWAY_STATES;
17
+ export type WebSocketGatewayState = IWebSocketGatewayStates[keyof IWebSocketGatewayStates];
18
+ export type ConnectionProvider = (url: string, options: IWebSocketGatewayConnectionOptions) => ISocket;
19
+ export interface IWebSocketGatewayOptions {
20
+ rejectUnauthorized?: boolean;
21
+ autoReconnect?: boolean;
22
+ agent?: unknown;
23
+ onError?: (error: unknown) => void;
24
+ timeout?: number;
25
+ requestTimeout?: number;
26
+ }
27
+ export interface ISocket extends Socket {
28
+ }
29
+ export interface IWebSocketGatewayConnectionOptions extends ManagerOptions {
30
+ parser: {
31
+ Decoder: (new (...args: unknown[]) => IODecoder);
32
+ Encoder: (new (...args: unknown[]) => IOEncoder);
33
+ };
34
+ }
35
+ export interface IWebSocketGateway extends Emitter {
36
+ _sendRequest<T extends IMessage>(serviceName: number, method: string, buffer: Uint8Array): Promise<T>;
37
+ _getChannel(serviceName: string | number, channelId: string): Channel;
38
+ disconnect(): void;
39
+ reconnect(): Promise<void>;
40
+ me?: User;
41
+ /**
42
+ * @deprecated - Use `socketId` property instead
43
+ */
44
+ sessionId?: string;
45
+ socketId?: string;
46
+ state?: WebSocketGatewayState;
47
+ }
48
+ declare const WebSocketGateway_base: {
49
+ new (): import("@ckeditor/ckeditor5-utils").Observable;
50
+ prototype: import("@ckeditor/ckeditor5-utils").Observable;
51
+ };
52
+ /**
53
+ * Represents class for connecting to CKEditor Cloud Services WebSocket API.
54
+ */
55
+ declare class WebSocketGateway extends /* #__PURE__ -- @preserve */ WebSocketGateway_base {
56
+ private readonly _requestsManager;
57
+ private readonly _url;
58
+ private _socket?;
59
+ private _socketAuth?;
60
+ private readonly _channels;
61
+ private _connectionAttempt;
62
+ private readonly _token;
63
+ private readonly _options;
64
+ private readonly _connectionProvider;
65
+ private readonly _userFactory;
66
+ /**
67
+ * Represents currently logged user as taken from CMS (Token). Undefined value represents anonymous user.
68
+ */
69
+ me?: User;
70
+ /**
71
+ * Id of an EndUser's socket.
72
+ */
73
+ socketId?: string;
74
+ /**
75
+ * WebSocketGateway connection state.
76
+ */
77
+ state?: WebSocketGatewayState;
78
+ /**
79
+ * Defines "disconnected" state. Returned by {@link WebSocketGateway#state}.
80
+ */
81
+ static readonly STATE_DISCONNECTED: string;
82
+ /**
83
+ * Defines "connecting" state. Returned by {@link WebSocketGateway#state}.
84
+ */
85
+ static readonly STATE_CONNECTING: string;
86
+ /**
87
+ * Defines "connected" state. Returned by {@link WebSocketGateway#state}.
88
+ */
89
+ static readonly STATE_CONNECTED: string;
90
+ /**
91
+ * Returns highest priority for `change:state` handlers.
92
+ */
93
+ static readonly _CHANGE_STATE_EVENT_PRIORITY: number;
94
+ constructor(apiAddress: string, token: IToken, options?: IWebSocketGatewayOptions, connectionProvider?: ConnectionProvider, userFactory?: (wsGateway: IWebSocketGateway, id: string) => Promise<User>);
95
+ /**
96
+ * Id of an EndUser's Session.
97
+ *
98
+ * @deprecated - Use `socketId` property instead
99
+ */
100
+ get sessionId(): string | undefined;
101
+ /**
102
+ * Wait for fulfilled all sent requests.
103
+ * This method might be called before the call disconnect method to ensure all requests are fulfilled.
104
+ */
105
+ waitForAllRequests(time?: number): Promise<void>;
106
+ /**
107
+ * Disconnects from WebSocket Gateway.
108
+ */
109
+ disconnect(): void;
110
+ /**
111
+ * Reconnects disconnected WebSocket Gateway.
112
+ * Only works if it is in disconnected {@link WebSocketGateway#state} otherwise returns resolved promise.
113
+ */
114
+ reconnect(): Promise<void>;
115
+ /**
116
+ * Connects to CKEditor Cloud Services.
117
+ *
118
+ * const token = await Token.create( 'https://token-endpoint' );
119
+ * const webSocketGateway = await WebSocketGateway.connect( token );
120
+ */
121
+ static connect(token: IToken, apiAddress?: string, options?: IWebSocketGatewayOptions, provider?: ConnectionProvider, userFactory?: (wsGateway: IWebSocketGateway, id: string) => Promise<User>): Promise<WebSocketGateway>;
122
+ /**
123
+ * Sends request to CKEditor Cloud Services.
124
+ */
125
+ _sendRequest<TResponse extends IMessage>(serviceName: number, method: string, buffer: Uint8Array): Promise<TResponse>;
126
+ /**
127
+ * Returns {@link Channel} associated with given service.
128
+ */
129
+ _getChannel(serviceName: string | number, channelId: string): Channel;
130
+ private _connect;
131
+ private _getPortByProtocol;
132
+ /**
133
+ * Creates unconnected Socket instance or returns already existing one.
134
+ */
135
+ private _setupSocket;
136
+ /**
137
+ * Emits event via socket.
138
+ */
139
+ private _emit;
140
+ private _addAuthData;
141
+ private _removeAuthData;
142
+ /**
143
+ * Socket.io `connect` events handler.
144
+ */
145
+ private _onConnect;
146
+ /**
147
+ * Socket.io `reconnect` events handler.
148
+ */
149
+ private _onReconnect;
150
+ /**
151
+ * Socket.io `disconnect` events handler.
152
+ */
153
+ private _onDisconnect;
154
+ private _debugEvent;
155
+ /**
156
+ * Socket.io `reconnect_error` events handler.
157
+ */
158
+ private _reconnectionAttemptError;
159
+ /**
160
+ * `onUnauthorized` events handler.
161
+ */
162
+ private _onUnauthorized;
163
+ /**
164
+ * Authenticates socket.
165
+ */
166
+ private _authenticate;
167
+ private _isDebugModeEnabled;
168
+ }
169
+ export default WebSocketGateway;