@ckeditor/ckeditor-cloud-services-collaboration 47.0.0 → 48.0.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.
- package/package.json +10 -5
- package/src/ckeditorcloudserviceserror.d.ts +8 -0
- package/src/ckeditorcloudserviceserror.js +1 -1
- package/src/ckeditorcloudservicesservererror.d.ts +15 -0
- package/src/ckeditorcloudservicesservererror.js +1 -1
- package/src/collaborativeeditingservice/collaborativeeditingservice.d.ts +127 -0
- package/src/collaborativeeditingservice/collaborativeeditingservice.js +1 -1
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.d.ts +18 -0
- package/src/collaborativeeditingservice/descriptors/operationmetadatadescriptor.js +1 -1
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.d.ts +11 -0
- package/src/collaborativeeditingservice/helpers/operationmetadatahelpers.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.d.ts +24 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.d.ts +19 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingreconnectmessage.js +1 -1
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.d.ts +38 -0
- package/src/collaborativeeditingservice/messages/collaborativeeditingupdatemessage.js +1 -1
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.d.ts +16 -0
- package/src/collaborativeeditingservice/messages/getdocumentdetailsmessage.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.d.ts +68 -0
- package/src/collaborativeeditingservice/responses/collaborativeeditingconnectresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.d.ts +51 -0
- package/src/collaborativeeditingservice/responses/collaborativeeditingresponse.js +1 -1
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.d.ts +28 -0
- package/src/collaborativeeditingservice/responses/getdocumentdetailsresponse.js +1 -1
- package/src/comments-v2/commentsservice.d.ts +71 -0
- package/src/comments-v2/commentsservice.js +1 -1
- package/src/comments-v2/descriptors/commentdescriptor.d.ts +23 -0
- package/src/comments-v2/descriptors/commentdescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentsthreaddescriptor.d.ts +29 -0
- package/src/comments-v2/descriptors/commentsthreaddescriptor.js +1 -1
- package/src/comments-v2/descriptors/commentthreadaddedcomment.d.ts +15 -0
- package/src/comments-v2/descriptors/commentthreadaddedcomment.js +1 -1
- package/src/comments-v2/messages/addcommentmessage.d.ts +30 -0
- package/src/comments-v2/messages/addcommentmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.d.ts +32 -0
- package/src/comments-v2/messages/comment-threads/addcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/comment-threads/reopencommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.d.ts +21 -0
- package/src/comments-v2/messages/comment-threads/resolvecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.d.ts +21 -0
- package/src/comments-v2/messages/comment-threads/updatecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/connectmessage.d.ts +15 -0
- package/src/comments-v2/messages/connectmessage.js +1 -1
- package/src/comments-v2/messages/getcommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/getcommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/getdocumentthreadsmessage.d.ts +15 -0
- package/src/comments-v2/messages/getdocumentthreadsmessage.js +1 -1
- package/src/comments-v2/messages/removecommentmessage.d.ts +19 -0
- package/src/comments-v2/messages/removecommentmessage.js +1 -1
- package/src/comments-v2/messages/removecommentthreadmessage.d.ts +17 -0
- package/src/comments-v2/messages/removecommentthreadmessage.js +1 -1
- package/src/comments-v2/messages/updatecommentmessage.d.ts +28 -0
- package/src/comments-v2/messages/updatecommentmessage.js +1 -1
- package/src/comments-v2/responses/addcommentresponse.d.ts +17 -0
- package/src/comments-v2/responses/addcommentresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.d.ts +22 -0
- package/src/comments-v2/responses/comment-threads/addcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.d.ts +19 -0
- package/src/comments-v2/responses/comment-threads/resolvecommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/connectresponse.d.ts +19 -0
- package/src/comments-v2/responses/connectresponse.js +1 -1
- package/src/comments-v2/responses/getcommentthreadresponse.d.ts +31 -0
- package/src/comments-v2/responses/getcommentthreadresponse.js +1 -1
- package/src/comments-v2/responses/getdocumentthreadsresponse.d.ts +17 -0
- package/src/comments-v2/responses/getdocumentthreadsresponse.js +1 -1
- package/src/compiledmessages.d.ts +9 -0
- package/src/compiledmessages.js +1 -1
- package/src/descriptor.d.ts +13 -0
- package/src/descriptor.js +1 -1
- package/src/descriptors/keyvaluedescriptor.d.ts +5 -0
- package/src/descriptors/keyvaluedescriptor.js +1 -1
- package/src/editor/editorservice.d.ts +11 -0
- package/src/editor/editorservice.js +1 -1
- package/src/editor/messages/iseditorbundleuploadedmessage.d.ts +15 -0
- package/src/editor/messages/iseditorbundleuploadedmessage.js +1 -1
- package/src/editor/responses/iseditorbundleuploadedresponse.d.ts +13 -0
- package/src/editor/responses/iseditorbundleuploadedresponse.js +1 -1
- package/src/errors/ServiceNotConnectedError.d.ts +4 -0
- package/src/errors/ServiceNotConnectedError.js +1 -1
- package/src/index.d.ts +66 -0
- package/src/index.js +1 -1
- package/src/message.d.ts +17 -0
- package/src/message.js +1 -1
- package/src/messagescompressor.d.ts +15 -0
- package/src/messagescompressor.js +1 -1
- package/src/messagesmapper.d.ts +9 -0
- package/src/messagesmapper.js +1 -1
- package/src/revision-history/descriptors/revisiondescriptor.d.ts +42 -0
- package/src/revision-history/descriptors/revisiondescriptor.js +1 -1
- package/src/revision-history/messages/revisionhistoryconnectmessage.d.ts +15 -0
- package/src/revision-history/messages/revisionhistoryconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.d.ts +17 -0
- package/src/revision-history/messages/revisionhistorygetrevisionmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryreconnectmessage.d.ts +17 -0
- package/src/revision-history/messages/revisionhistoryreconnectmessage.js +1 -1
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.d.ts +41 -0
- package/src/revision-history/messages/revisionhistoryupdaterevisionsmessage.js +1 -1
- package/src/revision-history/responses/revisionhistoryconnectresponse.d.ts +30 -0
- package/src/revision-history/responses/revisionhistoryconnectresponse.js +1 -1
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.d.ts +30 -0
- package/src/revision-history/responses/revisionhistorygetrevisionresponse.js +1 -1
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.d.ts +13 -0
- package/src/revision-history/responses/revisionhistoryupdaterevisionsresponse.js +1 -1
- package/src/revision-history/revision.d.ts +15 -0
- package/src/revision-history/revisionhistoryservice.d.ts +75 -0
- package/src/revision-history/revisionhistoryservice.js +1 -1
- package/src/services.d.ts +8 -0
- package/src/services.js +23 -0
- package/src/sessions/descriptors/sessiondescriptor.d.ts +5 -0
- package/src/sessions/descriptors/sessiondescriptor.js +1 -1
- package/src/sessions/messages/sessionsconnectmessage.d.ts +17 -0
- package/src/sessions/messages/sessionsconnectmessage.js +1 -1
- package/src/sessions/messages/socketconnectmessage.d.ts +21 -0
- package/src/sessions/messages/socketconnectmessage.js +1 -1
- package/src/sessions/messages/socketdisconnectmessage.d.ts +15 -0
- package/src/sessions/messages/socketdisconnectmessage.js +1 -1
- package/src/sessions/responses/sessionsconnectresponse.d.ts +21 -0
- package/src/sessions/responses/sessionsconnectresponse.js +1 -1
- package/src/sessions/sessioncollection.d.ts +39 -0
- package/src/sessions/sessioncollection.js +1 -1
- package/src/sessions/sessions.d.ts +14 -0
- package/src/sessions/sessions.js +1 -1
- package/src/track-changes/descriptors/suggestiondescriptor.d.ts +25 -0
- package/src/track-changes/descriptors/suggestiondescriptor.js +1 -1
- package/src/track-changes/messages/addsuggestionmessage.d.ts +25 -0
- package/src/track-changes/messages/addsuggestionmessage.js +1 -1
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.d.ts +19 -0
- package/src/track-changes/messages/batchUpdateSuggestionsStateMessage.js +1 -1
- package/src/track-changes/messages/connectmessage.d.ts +15 -0
- package/src/track-changes/messages/connectmessage.js +1 -1
- package/src/track-changes/messages/getallsuggestionsmessage.d.ts +15 -0
- package/src/track-changes/messages/getallsuggestionsmessage.js +1 -1
- package/src/track-changes/messages/getsuggestionmessage.d.ts +17 -0
- package/src/track-changes/messages/getsuggestionmessage.js +1 -1
- package/src/track-changes/messages/updatesuggestionmessage.d.ts +25 -0
- package/src/track-changes/messages/updatesuggestionmessage.js +1 -1
- package/src/track-changes/responses/addsuggestionresponse.d.ts +27 -0
- package/src/track-changes/responses/addsuggestionresponse.js +1 -1
- package/src/track-changes/responses/connectresponse.d.ts +19 -0
- package/src/track-changes/responses/connectresponse.js +1 -1
- package/src/track-changes/responses/getallsuggestionsresponse.d.ts +17 -0
- package/src/track-changes/responses/getallsuggestionsresponse.js +1 -1
- package/src/track-changes/responses/getsuggestionresponse.d.ts +27 -0
- package/src/track-changes/responses/getsuggestionresponse.js +1 -1
- package/src/track-changes/trackchangesservice.d.ts +62 -0
- package/src/track-changes/trackchangesservice.js +1 -1
- package/src/types.d.ts +7 -0
- package/src/users/descriptors/userdescriptor.d.ts +5 -0
- package/src/users/descriptors/userdescriptor.js +1 -1
- package/src/users/messages/getmanyusersmessage.d.ts +15 -0
- package/src/users/messages/getmanyusersmessage.js +1 -1
- package/src/users/messages/getusermessage.d.ts +15 -0
- package/src/users/messages/getusermessage.js +1 -1
- package/src/users/responses/getmanyusersresponse.d.ts +13 -0
- package/src/users/responses/getmanyusersresponse.js +1 -1
- package/src/users/responses/getuserresponse.d.ts +13 -0
- package/src/users/responses/getuserresponse.js +1 -1
- package/src/users/user.d.ts +41 -0
- package/src/users/user.js +1 -1
- package/src/version.d.ts +2 -0
- package/src/version.js +1 -1
- package/src/websocketgateway/channel.d.ts +31 -0
- package/src/websocketgateway/channel.js +1 -1
- package/src/websocketgateway/messages/channelmessage.d.ts +21 -0
- package/src/websocketgateway/messages/channelmessage.js +1 -1
- package/src/websocketgateway/parser/packetparser.d.ts +15 -0
- package/src/websocketgateway/parser/packetparser.js +1 -1
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/bytesbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/numberbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numbernumberpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numberobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.d.ts +17 -0
- package/src/websocketgateway/parser/packets/numberstringpacketdatamessag.js +1 -1
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/objectbufferpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/objectobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packagedatamessage.d.ts +16 -0
- package/src/websocketgateway/parser/packets/packagedatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetmessage.d.ts +31 -0
- package/src/websocketgateway/parser/packets/packetmessage.js +1 -1
- package/src/websocketgateway/parser/packets/packetoptionsmessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/packetoptionsmessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.d.ts +18 -0
- package/src/websocketgateway/parser/packets/stringbytespacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringnumberpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringobjectpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.d.ts +17 -0
- package/src/websocketgateway/parser/packets/stringstringpacketdatamessage.js +1 -1
- package/src/websocketgateway/parser/parser.d.ts +14 -0
- package/src/websocketgateway/parser/parser.js +1 -1
- package/src/websocketgateway/parser/parserutils.d.ts +27 -0
- package/src/websocketgateway/parser/parserutils.js +1 -1
- package/src/websocketgateway/requestsmanager.d.ts +20 -0
- package/src/websocketgateway/requestsmanager.js +1 -1
- package/src/websocketgateway/websocketgateway.d.ts +164 -0
- package/src/websocketgateway/websocketgateway.js +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor-cloud-services-collaboration",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "48.0.0",
|
|
4
4
|
"description": "CKEditor Cloud Services Collaboration low-level API is required by CKEditor 5 Collaboration features to enable real-time collaborative editing within the CKEditor 5.",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -27,11 +27,16 @@
|
|
|
27
27
|
"author": "CKSource Holding sp. z o.o. (http://cksource.com/)",
|
|
28
28
|
"homepage": "https://ckeditor.com/ckeditor-cloud-services/",
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"ckeditor5": "38.
|
|
30
|
+
"ckeditor5": "38.1.0",
|
|
31
31
|
"protobufjs": "7.0.0",
|
|
32
|
-
"socket.io-client": "4.
|
|
33
|
-
"socket.io-parser": "4.2.
|
|
32
|
+
"socket.io-client": "4.6.1",
|
|
33
|
+
"socket.io-parser": "4.2.3",
|
|
34
34
|
"url-parse": "1.5.10",
|
|
35
35
|
"uuid": "8.3.2"
|
|
36
|
-
}
|
|
36
|
+
},
|
|
37
|
+
"engines": {
|
|
38
|
+
"node": ">=8.0.0",
|
|
39
|
+
"npm": "^4.0.0"
|
|
40
|
+
},
|
|
41
|
+
"obfuscated": true
|
|
37
42
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IPublicError } from './ckeditorcloudservicesservererror';
|
|
2
|
+
export default class CKEditorCloudServicesError extends Error {
|
|
3
|
+
readonly context?: unknown;
|
|
4
|
+
readonly code: string | null;
|
|
5
|
+
readonly data: Record<string, unknown>;
|
|
6
|
+
constructor(message: string, context?: unknown, code?: string | null, data?: Record<string, unknown>);
|
|
7
|
+
static fromPublicError(publicError: IPublicError): CKEditorCloudServicesError;
|
|
8
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesError extends Error{constructor(
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesError extends Error{constructor(_0x4feae3,_0x17039e,_0x4692d5=null,_0x346a8d={}){super('cloud-services-internal-error:\x20'+_0x4feae3),this['context']=_0x17039e,this['code']=_0x4692d5,this['data']=_0x346a8d,this['name']='CKEditorError';}static['fromPublicError'](_0x23895e){return new CKEditorCloudServicesError(function(_0x4cff70){let _0x43f691='cloud-services-error:\x20'+_0x4cff70['message'];return _0x4cff70['explanation']&&(_0x43f691+='\x0aExplanation:\x20'+_0x4cff70['explanation']),_0x4cff70['action']&&(_0x43f691+='\x0aAction:\x20'+_0x4cff70['action']),_0x4cff70['traceId']&&(_0x43f691+='\x0aTraceId:\x20'+_0x4cff70['traceId']),_0x4cff70['code']&&(_0x43f691+='\x0aCode:\x20'+_0x4cff70['code']),_0x43f691;}(_0x23895e),_0x23895e);}}exports['default']=CKEditorCloudServicesError;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export interface IPublicError {
|
|
2
|
+
message: string;
|
|
3
|
+
traceId?: string;
|
|
4
|
+
data?: Record<string, unknown>;
|
|
5
|
+
code?: string;
|
|
6
|
+
explanation?: string;
|
|
7
|
+
action?: string;
|
|
8
|
+
}
|
|
9
|
+
export default class CKEditorCloudServicesServerError extends Error {
|
|
10
|
+
readonly code?: string;
|
|
11
|
+
readonly traceId?: string;
|
|
12
|
+
readonly data?: Record<string, unknown>;
|
|
13
|
+
private constructor();
|
|
14
|
+
static fromPublicError(publicError: IPublicError): CKEditorCloudServicesServerError;
|
|
15
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesServerError extends Error{constructor(
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0});class CKEditorCloudServicesServerError extends Error{constructor(_0x85764a,_0x181306){super(),this['name']='CKEditorCloudServicesServerError',this['stack']=void 0x0,this['message']=_0x85764a,this['code']=_0x181306['code'],this['traceId']=_0x181306['traceId'],this['data']=_0x181306['data'];}static['fromPublicError'](_0x5da96b){return new CKEditorCloudServicesServerError(function(_0x175736){let _0x246ded='cloud-services-server-error:\x20'+_0x175736['message'];return _0x175736['explanation']&&(_0x246ded+='\x0aExplanation:\x20'+_0x175736['explanation']),_0x175736['action']&&(_0x246ded+='\x0aAction:\x20'+_0x175736['action']),_0x175736['traceId']&&(_0x246ded+='\x0aTraceId:\x20'+_0x175736['traceId']),_0x175736['code']&&(_0x246ded+='\x0aCode:\x20'+_0x175736['code']),_0x246ded;}(_0x5da96b),_0x5da96b);}}exports['default']=CKEditorCloudServicesServerError;
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import CollaborativeEditingConnectMessage from './messages/collaborativeeditingconnectmessage';
|
|
3
|
+
import CollaborativeEditingReconnectMessage from './messages/collaborativeeditingreconnectmessage';
|
|
4
|
+
import CollaborativeEditingResponse from './responses/collaborativeeditingresponse';
|
|
5
|
+
import CollaborativeEditingConnectResponse from './responses/collaborativeeditingconnectresponse';
|
|
6
|
+
import { IWebSocketGateway } from './../websocketgateway/websocketgateway';
|
|
7
|
+
import SessionCollection from '../sessions/sessioncollection';
|
|
8
|
+
import GetDocumentDetailsResponse from './responses/getdocumentdetailsresponse';
|
|
9
|
+
export declare const _SERVICE: number;
|
|
10
|
+
export interface IOperationsData {
|
|
11
|
+
buffers: (Buffer | Uint8Array)[];
|
|
12
|
+
types: number[];
|
|
13
|
+
}
|
|
14
|
+
declare const CollaborativeEditingService_base: {
|
|
15
|
+
new (): import("ckeditor5/src/utils").Emitter;
|
|
16
|
+
prototype: import("ckeditor5/src/utils").Emitter;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* General purpose CollaborativeEditingService used to synchronize data store values with other collaborative nodes.
|
|
20
|
+
*/
|
|
21
|
+
declare class CollaborativeEditingService extends CollaborativeEditingService_base {
|
|
22
|
+
static _SERVICE: number;
|
|
23
|
+
private readonly _bundleVersion;
|
|
24
|
+
private readonly _id;
|
|
25
|
+
private _isConnected;
|
|
26
|
+
private _wsGateway?;
|
|
27
|
+
private _channel?;
|
|
28
|
+
private _connectedSessions?;
|
|
29
|
+
/**
|
|
30
|
+
* Create CollaborativeEditingService instance.
|
|
31
|
+
*
|
|
32
|
+
* const collabWritingService = new CollaborativeEditingService( '0.9.0', 'post-456-text' );
|
|
33
|
+
*
|
|
34
|
+
* @throws {TypeError}
|
|
35
|
+
* Throws when bundleVersion param is not provided.
|
|
36
|
+
*/
|
|
37
|
+
constructor(bundleVersion: string, serviceId?: string);
|
|
38
|
+
getId(): string;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates that CollaborativeEditingService is connected to CKEditor Cloud Services.
|
|
41
|
+
*/
|
|
42
|
+
isConnected(): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Connects CollaborativeEditingService to CKEditor Cloud Services.
|
|
45
|
+
*
|
|
46
|
+
* const myDocument = new CollaborativeEditingService( '0.9.0', 'article-1234' );
|
|
47
|
+
*
|
|
48
|
+
* await myDocument.connect( wsGateway );
|
|
49
|
+
*
|
|
50
|
+
* @throws {CKEditorCloudServicesError}
|
|
51
|
+
* Thrown in the case of errors on the backend side.
|
|
52
|
+
*/
|
|
53
|
+
connect(wsGateway: IWebSocketGateway, data?: {
|
|
54
|
+
buffers: Buffer[];
|
|
55
|
+
types: number[];
|
|
56
|
+
}, lastOperationId?: string): Promise<CollaborativeEditingConnectResponse | void>;
|
|
57
|
+
/**
|
|
58
|
+
* Reconnects CollaborativeEditingService to CKEditor Cloud Services.
|
|
59
|
+
*
|
|
60
|
+
* const myDocument = new CollaborativeEditingService( '0.9.0', 'article-1234' );
|
|
61
|
+
*
|
|
62
|
+
* await myDocument.connect( wsGateway );
|
|
63
|
+
*
|
|
64
|
+
* wsGateway.on( 'change:state', ( event, property, value ) => {
|
|
65
|
+
* if( value === 'disconnected' ) {
|
|
66
|
+
* await myDocument.reconnect( wsGateway, 123 );
|
|
67
|
+
* }
|
|
68
|
+
* } );
|
|
69
|
+
*
|
|
70
|
+
* @throws {CKEditorCloudServicesError}
|
|
71
|
+
* Thrown when connection already exists or in the case of errors on the backend side.
|
|
72
|
+
*/
|
|
73
|
+
reconnect(wsGateway: IWebSocketGateway, lastKnowVersion: number): Promise<CollaborativeEditingConnectResponse>;
|
|
74
|
+
/**
|
|
75
|
+
* Disconnects CollaborativeEditingService from CKEditor Cloud Services.
|
|
76
|
+
*
|
|
77
|
+
* @throws {CKEditorCloudServicesError}
|
|
78
|
+
* Thrown in the case of errors on the backend side.
|
|
79
|
+
*/
|
|
80
|
+
disconnect(): void;
|
|
81
|
+
/**
|
|
82
|
+
* Gets document details from CKEditor Cloud Services.
|
|
83
|
+
*
|
|
84
|
+
* @throws {CKEditorCloudServicesError}
|
|
85
|
+
* Thrown in the case of errors on the backend side.
|
|
86
|
+
*/
|
|
87
|
+
getDocumentDetails(): Promise<GetDocumentDetailsResponse>;
|
|
88
|
+
/**
|
|
89
|
+
* Sends update to connected service. This will propagate update to other connected CollaborativeEditingService.
|
|
90
|
+
* Data update will not be stored on CollaborativeEditingService server instance.
|
|
91
|
+
*
|
|
92
|
+
* @throws {CKEditorCloudServicesError}
|
|
93
|
+
* Throws when baseVersion or data is not provided, data is empty, or in the case of errors on the backend side.
|
|
94
|
+
*
|
|
95
|
+
* @throws {ServiceNotConnectedError}
|
|
96
|
+
* Throws when collaborative editing service is not connected.
|
|
97
|
+
*/
|
|
98
|
+
sendOperations(data: IOperationsData, baseVersion: number | string, lastOperationId: string): Promise<CollaborativeEditingResponse>;
|
|
99
|
+
/**
|
|
100
|
+
* Returns read-only observable collection with EndUsers Sessions for collaborative editing service.
|
|
101
|
+
*
|
|
102
|
+
* @throws {CKEditorCloudServicesError}
|
|
103
|
+
* Thrown in the case of errors on the backend side.
|
|
104
|
+
*/
|
|
105
|
+
getConnectedSessions(): Promise<SessionCollection>;
|
|
106
|
+
/**
|
|
107
|
+
* Returns a Promise that resolves with read-only observable collection with EndUsers Sessions for given id.
|
|
108
|
+
*
|
|
109
|
+
* const sessions = await CollaborativeEditingService.getConnectedSessions( 'my-document-id' );
|
|
110
|
+
*
|
|
111
|
+
* @deprecated Use not static version of getConnectedSessions method.
|
|
112
|
+
*
|
|
113
|
+
* @throws {CKEditorCloudServicesError}
|
|
114
|
+
* Throws in the case of errors on the backend side.
|
|
115
|
+
*/
|
|
116
|
+
static getConnectedSessions(wsGateway: IWebSocketGateway, id: string): Promise<SessionCollection>;
|
|
117
|
+
_connect(wsGateway: IWebSocketGateway, message: CollaborativeEditingConnectMessage | CollaborativeEditingReconnectMessage): Promise<CollaborativeEditingConnectResponse | void>;
|
|
118
|
+
/**
|
|
119
|
+
* Connects given CollaborativeEditingService to channel.
|
|
120
|
+
*/
|
|
121
|
+
protected _connectToChannel(wsGateway: IWebSocketGateway, channelName: string): void;
|
|
122
|
+
/**
|
|
123
|
+
* WebSocketGateway "change:state" events handler.
|
|
124
|
+
*/
|
|
125
|
+
private _onWsGatewayStateChange;
|
|
126
|
+
}
|
|
127
|
+
export default CollaborativeEditingService;
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x367533){return _0x367533&&_0x367533['__esModule']?_0x367533:{'default':_0x367533};};Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['_SERVICE']=void 0x0;const uuid_1=require('uuid'),utils_1=require('ckeditor5/src/utils'),messagescompressor_1=__importDefault(require('./../messagescompressor')),sessions_1=__importDefault(require('./../sessions/sessions')),collaborativeeditingconnectmessage_1=__importDefault(require('./messages/collaborativeeditingconnectmessage')),collaborativeeditingupdatemessage_1=__importDefault(require('./messages/collaborativeeditingupdatemessage')),collaborativeeditingreconnectmessage_1=__importDefault(require('./messages/collaborativeeditingreconnectmessage')),collaborativeeditingresponse_1=__importDefault(require('./responses/collaborativeeditingresponse')),collaborativeeditingconnectresponse_1=__importDefault(require('./responses/collaborativeeditingconnectresponse')),websocketgateway_1=__importDefault(require('./../websocketgateway/websocketgateway')),ckeditorcloudserviceserror_1=__importDefault(require('../ckeditorcloudserviceserror')),ServiceNotConnectedError_1=__importDefault(require('../errors/ServiceNotConnectedError')),getdocumentdetailsresponse_1=__importDefault(require('./responses/getdocumentdetailsresponse')),getdocumentdetailsmessage_1=__importDefault(require('./messages/getdocumentdetailsmessage'));exports['_SERVICE']=0x1;class CollaborativeEditingService extends(0x0,utils_1['EmitterMixin'])(){constructor(_0xd48d5f,_0x2d9c94){if(super(),!_0xd48d5f)throw new TypeError('Param\x20\x22bundleVersion\x22\x20must\x20be\x20provided.');this['_id']=null!=_0x2d9c94?_0x2d9c94:(0x0,uuid_1['v4'])(),this['_isConnected']=!0x1,this['_bundleVersion']=_0xd48d5f;}['getId'](){return this['_id'];}['isConnected'](){return this['_isConnected'];}['connect'](_0x5e7bb2,_0x484e83={'buffers':[],'types':[]},_0x5a5805){const _0x3d4879=new collaborativeeditingconnectmessage_1['default'](this['getId'](),_0x484e83['buffers'],_0x484e83['types'],this['_bundleVersion'],_0x5a5805);return this['_connect'](_0x5e7bb2,_0x3d4879);}['reconnect'](_0x5cdc65,_0x420a22){if(this['isConnected']())throw new ckeditorcloudserviceserror_1['default']('Cannot\x20reconnect\x20to\x20already\x20connected\x20service.',_0x5cdc65);return this['_connect'](_0x5cdc65,new collaborativeeditingreconnectmessage_1['default'](this['getId'](),_0x420a22,this['_bundleVersion']));}['disconnect'](){this['_isConnected']&&(this['_isConnected']=!0x1,this['_wsGateway']&&(this['stopListening'](this['_wsGateway']),this['_wsGateway']=void 0x0),this['_channel']&&(this['stopListening'](this['_channel']),this['_channel']=void 0x0),this['_connectedSessions']&&(this['_connectedSessions']['disconnect'](),this['_connectedSessions']=void 0x0),this['fire']('disconnected'),this['stopListening']());}async['getDocumentDetails'](){const _0x4c40ee=new getdocumentdetailsmessage_1['default'](this['getId']());if(!this['_wsGateway'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);const _0xedde75=await this['_wsGateway']['_sendRequest'](exports['_SERVICE'],getdocumentdetailsmessage_1['default']['TYPE'],messagescompressor_1['default']['encode'](_0x4c40ee));return messagescompressor_1['default']['decode'](_0xedde75,getdocumentdetailsresponse_1['default']);}async['sendOperations'](_0x59413d,_0x35c500,_0x581a87){if(!_0x59413d||!_0x59413d['types']||!_0x59413d['types']['length'])throw new ckeditorcloudserviceserror_1['default']('Cannot\x20send\x20empty\x20update.',this['_wsGateway']);const _0xc45e4f='number'==typeof _0x35c500?_0x35c500:parseInt(_0x35c500);if(!Number['isInteger'](_0xc45e4f)||_0xc45e4f<0x0)throw new ckeditorcloudserviceserror_1['default']('Base\x20version\x20not\x20provided.',this['_wsGateway']);const _0x3d2dc2=new collaborativeeditingupdatemessage_1['default'](this['getId'](),_0x59413d['buffers'],_0x59413d['types'],_0xc45e4f,[],_0x581a87);if(!this['_wsGateway']||!this['_isConnected'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);const _0x246f81=await this['_wsGateway']['_sendRequest'](exports['_SERVICE'],collaborativeeditingupdatemessage_1['default']['TYPE'],messagescompressor_1['default']['encode'](_0x3d2dc2));return messagescompressor_1['default']['decode'](_0x246f81,collaborativeeditingresponse_1['default']);}async['getConnectedSessions'](){if(!this['_isConnected'])throw new ServiceNotConnectedError_1['default']('Collaborative\x20Editing',this);return this['_connectedSessions']||(this['_connectedSessions']=await sessions_1['default']['getConnectedSessions'](this['_wsGateway'],this['_id'],exports['_SERVICE'])),this['_connectedSessions'];}static['getConnectedSessions'](_0x51bd4c,_0x507d20){return sessions_1['default']['getConnectedSessions'](_0x51bd4c,_0x507d20,exports['_SERVICE']);}async['_connect'](_0x4234c5,_0x13df46){if(this['isConnected']())return;if(_0x4234c5['state']!==websocketgateway_1['default']['STATE_CONNECTED'])throw new ckeditorcloudserviceserror_1['default']('WebSocket\x20Gateway\x20is\x20not\x20connected.',_0x4234c5);this['_wsGateway']=_0x4234c5,this['stopListening'](_0x4234c5,'change:state');const _0x389a33=await _0x4234c5['_sendRequest'](exports['_SERVICE'],_0x13df46['constructor']['TYPE'],messagescompressor_1['default']['encode'](_0x13df46)),_0x24f08f=messagescompressor_1['default']['decode'](_0x389a33,collaborativeeditingconnectresponse_1['default']);return this['listenTo'](_0x4234c5,'change:state',(_0x2916ae,_0x51131f,_0x386fc5)=>this['_onWsGatewayStateChange'](_0x386fc5),{'priority':websocketgateway_1['default']['_CHANGE_STATE_EVENT_PRIORITY']}),this['_connectToChannel'](_0x4234c5,_0x24f08f['channel']),this['_isConnected']=!0x0,this['fire']('connected'),_0x24f08f;}['_connectToChannel'](_0x163da6,_0x363ec0){this['_channel']=_0x163da6['_getChannel'](exports['_SERVICE'],_0x363ec0),this['listenTo'](this['_channel'],this['_channel']['getEventName'](collaborativeeditingupdatemessage_1['default']['TYPE']),(_0x1856b2,_0xdce652)=>{const _0x1c21a1=messagescompressor_1['default']['decode'](_0xdce652,collaborativeeditingupdatemessage_1['default']);this['fire']('operationsReceived',_0x1c21a1['baseVersion'],_0x1c21a1['data'],_0x1c21a1['metadata']);});}['_onWsGatewayStateChange'](_0x44f8f5){_0x44f8f5===websocketgateway_1['default']['STATE_DISCONNECTED']&&this['disconnect']();}}CollaborativeEditingService['_SERVICE']=exports['_SERVICE'],exports['default']=CollaborativeEditingService;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import Descriptor, { IDescriptorBody } from './../../descriptor';
|
|
2
|
+
interface IBaseOperationMetadata {
|
|
3
|
+
userId: string;
|
|
4
|
+
type?: string;
|
|
5
|
+
}
|
|
6
|
+
export interface IOperationMetadata extends IBaseOperationMetadata {
|
|
7
|
+
createdAt?: Date;
|
|
8
|
+
}
|
|
9
|
+
export interface IOperationMetadataJSON extends IBaseOperationMetadata {
|
|
10
|
+
createdAt?: string;
|
|
11
|
+
}
|
|
12
|
+
export default class OperationMetadataDescriptor extends Descriptor {
|
|
13
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
14
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
15
|
+
static toJSON({ createdAt, ...metadata }: IOperationMetadata): IOperationMetadataJSON;
|
|
16
|
+
static fromJSON({ createdAt, ...metadata }: IOperationMetadataJSON): IOperationMetadata;
|
|
17
|
+
}
|
|
18
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x3d512e){return _0x3d512e&&_0x3d512e['__esModule']?_0x3d512e:{'default':_0x3d512e};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const descriptor_1=__importDefault(require('./../../descriptor'));class OperationMetadataDescriptor extends descriptor_1['default']{static['toJSON']({createdAt:createdAt,..._0x534cfa}){const _0x201997={..._0x534cfa};return(null==createdAt?void 0x0:createdAt['toISOString'])&&(_0x201997['createdAt']=createdAt['toISOString']()),_0x201997;}static['fromJSON']({createdAt:createdAt,..._0x219d2c}){const _0xffd6e0={..._0x219d2c};return createdAt&&(_0xffd6e0['createdAt']=new Date(createdAt)),_0xffd6e0;}}exports['default']=OperationMetadataDescriptor,OperationMetadataDescriptor['DESCRIPTOR_NAME']='OperationMetadataDescriptor',OperationMetadataDescriptor['DESCRIPTOR']={'fields':{'userId':{'type':'string','id':0x1},'type':{'type':'string','id':0x2},'createdAt':{'type':'string','id':0x3}}};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
2
|
+
export default class OperationMetadataHelpers {
|
|
3
|
+
/**
|
|
4
|
+
* Prepares metadata data for all operations. Adds metadata to operations with type 0.
|
|
5
|
+
*/
|
|
6
|
+
static prepareMetadataForOperations(types: number[], metadata: IOperationMetadataJSON[]): IOperationMetadataJSON[];
|
|
7
|
+
/**
|
|
8
|
+
* Removes unnecessary metadata for operations with type 0.
|
|
9
|
+
*/
|
|
10
|
+
static removeUnnecessaryMetadata(types: number[], metadata: IOperationMetadata[]): IOperationMetadata[];
|
|
11
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['default']=class{static['prepareMetadataForOperations'](
|
|
23
|
+
'use strict';Object['defineProperty'](exports,'__esModule',{'value':!0x0}),exports['default']=class{static['prepareMetadataForOperations'](_0x272310,_0x1c2c22){if(!(_0x272310&&_0x272310['length']&&_0x1c2c22&&_0x1c2c22['length']))return[];const _0x67696d=[];let _0x5953eb=0x0;for(const _0x139868 of _0x272310)if(0x0!==_0x139868){if(!_0x1c2c22[_0x5953eb])throw new Error('Missing\x20metadata\x20for\x20a\x20operation');_0x67696d['push'](_0x1c2c22[_0x5953eb]),_0x5953eb++;}else _0x67696d['push'](_0x67696d[_0x67696d['length']-0x1]);return _0x67696d;}static['removeUnnecessaryMetadata'](_0x1b9819,_0x5b9111){if(!(_0x1b9819&&_0x1b9819['length']&&_0x5b9111&&_0x5b9111['length']))return[];const _0x558aee=[];for(let _0x52a5b6=0x0;_0x52a5b6<_0x1b9819['length'];_0x52a5b6++)if(0x0!==_0x1b9819[_0x52a5b6]){if(!_0x5b9111[_0x52a5b6])throw new Error('Missing\x20metadata\x20for\x20a\x20operation');_0x558aee['push'](_0x5b9111[_0x52a5b6]);}return _0x558aee;}};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
export interface ICollaborativeEditingConnectMessage extends IMessage {
|
|
5
|
+
id: string;
|
|
6
|
+
bundleVersion: string;
|
|
7
|
+
buffers: Buffer[];
|
|
8
|
+
types: number[];
|
|
9
|
+
lastOperationId?: string;
|
|
10
|
+
}
|
|
11
|
+
export default class CollaborativeEditingConnectMessage extends Message {
|
|
12
|
+
readonly id: string;
|
|
13
|
+
readonly buffers: Buffer[];
|
|
14
|
+
readonly types: number[];
|
|
15
|
+
readonly bundleVersion: string;
|
|
16
|
+
readonly lastOperationId: string;
|
|
17
|
+
static readonly TYPE: string;
|
|
18
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
19
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
20
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
21
|
+
constructor(id: string, buffers: Buffer[], types: number[], bundleVersion: string, lastOperationId?: string);
|
|
22
|
+
toJSON(): ICollaborativeEditingConnectMessage;
|
|
23
|
+
static fromJSON(data: ICollaborativeEditingConnectMessage): CollaborativeEditingConnectMessage;
|
|
24
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x582742){return _0x582742&&_0x582742['__esModule']?_0x582742:{'default':_0x582742};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message'));class CollaborativeEditingConnectMessage extends message_1['default']{constructor(_0x36a21d,_0x48b55c,_0x586fce,_0x92d6bd,_0xd55e1c=''){super(),this['id']=_0x36a21d,this['buffers']=_0x48b55c,this['types']=_0x586fce,this['bundleVersion']=_0x92d6bd,this['lastOperationId']=_0xd55e1c;}['toJSON'](){return{'id':this['id'],'buffers':this['buffers'],'types':this['types'],'bundleVersion':this['bundleVersion'],'lastOperationId':this['lastOperationId']};}static['fromJSON'](_0x49518f){return new CollaborativeEditingConnectMessage(_0x49518f['id'],_0x49518f['buffers'],_0x49518f['types'],_0x49518f['bundleVersion'],_0x49518f['lastOperationId']);}}exports['default']=CollaborativeEditingConnectMessage,CollaborativeEditingConnectMessage['TYPE']='11',CollaborativeEditingConnectMessage['READABLE_TYPE_NAME']='connectToDocument',CollaborativeEditingConnectMessage['DESCRIPTOR_NAME']='CollaborativeEditingConnectMessage',CollaborativeEditingConnectMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'bundleVersion':{'type':'string','id':0x2},'buffers':{'rule':'repeated','type':'bytes','id':0x3},'types':{'rule':'repeated','type':'uint32','id':0x4},'lastOperationId':{'type':'string','id':0x5}}};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import Message, { IMessage } from './../../message';
|
|
2
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
3
|
+
export interface ICollaborativeEditingReconnectMessage extends IMessage {
|
|
4
|
+
id: string;
|
|
5
|
+
lastKnowVersion: number;
|
|
6
|
+
bundleVersion: string;
|
|
7
|
+
}
|
|
8
|
+
export default class CollaborativeEditingReconnectMessage extends Message {
|
|
9
|
+
readonly id: string;
|
|
10
|
+
readonly lastKnowVersion: number;
|
|
11
|
+
readonly bundleVersion: 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(id: string, lastKnowVersion: number, bundleVersion: string);
|
|
17
|
+
toJSON(): ICollaborativeEditingReconnectMessage;
|
|
18
|
+
static fromJSON(data: ICollaborativeEditingReconnectMessage): CollaborativeEditingReconnectMessage;
|
|
19
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x37cf57){return _0x37cf57&&_0x37cf57['__esModule']?_0x37cf57:{'default':_0x37cf57};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message'));class CollaborativeEditingReconnectMessage extends message_1['default']{constructor(_0x4228a0,_0x4bfd69,_0x197c66){super(),this['id']=_0x4228a0,this['lastKnowVersion']=_0x4bfd69,this['bundleVersion']=_0x197c66;}['toJSON'](){return{'id':this['id'],'bundleVersion':this['bundleVersion'],'lastKnowVersion':this['lastKnowVersion']};}static['fromJSON'](_0x1e430e){return new CollaborativeEditingReconnectMessage(_0x1e430e['id'],_0x1e430e['lastKnowVersion'],_0x1e430e['bundleVersion']);}}exports['default']=CollaborativeEditingReconnectMessage,CollaborativeEditingReconnectMessage['TYPE']='12',CollaborativeEditingReconnectMessage['READABLE_TYPE_NAME']='reconnectToDocument',CollaborativeEditingReconnectMessage['DESCRIPTOR_NAME']='CollaborativeEditingReconnectMessage',CollaborativeEditingReconnectMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'bundleVersion':{'type':'string','id':0x2},'lastKnowVersion':{'type':'uint32','id':0x3}}};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
5
|
+
export interface ICollaborativeEditingUpdateMessage extends IMessage {
|
|
6
|
+
id: string;
|
|
7
|
+
buffers: Buffer[] | Uint8Array[];
|
|
8
|
+
types: number[];
|
|
9
|
+
baseVersion: number;
|
|
10
|
+
metadata: IOperationMetadataJSON[];
|
|
11
|
+
lastOperationId?: string;
|
|
12
|
+
}
|
|
13
|
+
interface ICollaborativeEditingUpdateData {
|
|
14
|
+
buffers: Buffer[] | Uint8Array[];
|
|
15
|
+
types: number[];
|
|
16
|
+
baseVersion: number;
|
|
17
|
+
lastOperationId?: string;
|
|
18
|
+
}
|
|
19
|
+
export default class CollaborativeEditingUpdateMessage extends Message {
|
|
20
|
+
readonly id: string;
|
|
21
|
+
readonly buffers: Buffer[] | Uint8Array[];
|
|
22
|
+
readonly types: number[];
|
|
23
|
+
readonly baseVersion: number;
|
|
24
|
+
readonly metadata: IOperationMetadata[];
|
|
25
|
+
readonly lastOperationId: string;
|
|
26
|
+
static readonly TYPE: string;
|
|
27
|
+
static readonly READABLE_TYPE_NAME: string;
|
|
28
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
29
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
30
|
+
constructor(id: string, buffers: Buffer[] | Uint8Array[], types: number[], baseVersion: number, metadata?: IOperationMetadata[], lastOperationId?: string);
|
|
31
|
+
/**
|
|
32
|
+
* Returns compressed data of the operations.
|
|
33
|
+
*/
|
|
34
|
+
get data(): ICollaborativeEditingUpdateData;
|
|
35
|
+
toJSON(): ICollaborativeEditingUpdateMessage;
|
|
36
|
+
static fromJSON(data: ICollaborativeEditingUpdateMessage): CollaborativeEditingUpdateMessage;
|
|
37
|
+
}
|
|
38
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0xd96d0){return _0xd96d0&&_0xd96d0['__esModule']?_0xd96d0:{'default':_0xd96d0};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message')),operationmetadatahelpers_1=__importDefault(require('./../helpers/operationmetadatahelpers')),operationmetadatadescriptor_1=__importDefault(require('../descriptors/operationmetadatadescriptor'));class CollaborativeEditingUpdateMessage extends message_1['default']{constructor(_0x28e88e,_0x2cbb6b,_0xa58c56,_0x4f49db,_0x17b9da=[],_0x398e0f=''){super(),this['id']=_0x28e88e,this['buffers']=_0x2cbb6b,this['types']=_0xa58c56,this['baseVersion']=_0x4f49db,this['metadata']=_0x17b9da,this['lastOperationId']=_0x398e0f;}get['data'](){return{'buffers':this['buffers'],'types':this['types'],'baseVersion':this['baseVersion'],'lastOperationId':this['lastOperationId']};}['toJSON'](){return{'id':this['id'],'buffers':this['buffers'],'types':this['types'],'baseVersion':this['baseVersion'],'metadata':operationmetadatahelpers_1['default']['removeUnnecessaryMetadata'](this['types'],this['metadata'])['map'](operationmetadatadescriptor_1['default']['toJSON']),'lastOperationId':this['lastOperationId']};}static['fromJSON'](_0x2f0a0a){return new CollaborativeEditingUpdateMessage(_0x2f0a0a['id'],_0x2f0a0a['buffers'],_0x2f0a0a['types'],_0x2f0a0a['baseVersion'],operationmetadatahelpers_1['default']['prepareMetadataForOperations'](_0x2f0a0a['types'],_0x2f0a0a['metadata'])['map'](operationmetadatadescriptor_1['default']['fromJSON']),_0x2f0a0a['lastOperationId']);}}exports['default']=CollaborativeEditingUpdateMessage,CollaborativeEditingUpdateMessage['TYPE']='13',CollaborativeEditingUpdateMessage['READABLE_TYPE_NAME']='updateDocument',CollaborativeEditingUpdateMessage['DESCRIPTOR_NAME']='CollaborativeEditingUpdateMessage',CollaborativeEditingUpdateMessage['DESCRIPTOR']={'fields':{'id':{'type':'string','id':0x1},'baseVersion':{'type':'uint32','id':0x2},'buffers':{'rule':'repeated','type':'bytes','id':0x3},'types':{'rule':'repeated','type':'uint32','id':0x4},'metadata':{'rule':'repeated','type':'OperationMetadataDescriptor','id':0x6},'lastOperationId':{'type':'string','id':0x7}}};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import Message from '../../message';
|
|
2
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
3
|
+
export interface IGetDocumentDetailsMessage {
|
|
4
|
+
documentId: string;
|
|
5
|
+
}
|
|
6
|
+
export default class GetDocumentDetailsMessage 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
|
+
get data(): IGetDocumentDetailsMessage;
|
|
14
|
+
toJSON(): IGetDocumentDetailsMessage;
|
|
15
|
+
static fromJSON(data: IGetDocumentDetailsMessage): GetDocumentDetailsMessage;
|
|
16
|
+
}
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0x4ab37c){return _0x4ab37c&&_0x4ab37c['__esModule']?_0x4ab37c:{'default':_0x4ab37c};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('../../message'));class GetDocumentDetailsMessage extends message_1['default']{constructor(_0x5964dd){super(),this['documentId']=_0x5964dd;}get['data'](){return{'documentId':this['documentId']};}['toJSON'](){return{'documentId':this['documentId']};}static['fromJSON'](_0x3d5509){return new GetDocumentDetailsMessage(_0x3d5509['documentId']);}}exports['default']=GetDocumentDetailsMessage,GetDocumentDetailsMessage['TYPE']='14',GetDocumentDetailsMessage['READABLE_TYPE_NAME']='getDocumentDetails',GetDocumentDetailsMessage['DESCRIPTOR_NAME']='GetDocumentDetailsMessage',GetDocumentDetailsMessage['DESCRIPTOR']={'fields':{'documentId':{'type':'string','id':0x1},'environmentId':{'type':'string','id':0x2}}};
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import Message, { IMessage } from './../../message';
|
|
3
|
+
import { IDescriptorBody } from '../../descriptor';
|
|
4
|
+
import { IOperationMetadata, IOperationMetadataJSON } from '../descriptors/operationmetadatadescriptor';
|
|
5
|
+
export interface ICollaborativeEditingConnectResponse extends IMessage {
|
|
6
|
+
channel: string;
|
|
7
|
+
offset: number;
|
|
8
|
+
version: number;
|
|
9
|
+
sessionId: string;
|
|
10
|
+
buffers: Buffer[] | Uint8Array[];
|
|
11
|
+
types: number[];
|
|
12
|
+
metadata: IOperationMetadataJSON[];
|
|
13
|
+
initData: string;
|
|
14
|
+
isInitialized: boolean;
|
|
15
|
+
lastOperationId?: string;
|
|
16
|
+
sessionCreatedAt: string | null;
|
|
17
|
+
}
|
|
18
|
+
interface ICollaborativeEditingConnectResponseParams {
|
|
19
|
+
channel: string;
|
|
20
|
+
version: number;
|
|
21
|
+
sessionId?: string;
|
|
22
|
+
buffers?: Buffer[] | Uint8Array[];
|
|
23
|
+
types?: number[];
|
|
24
|
+
offset?: number;
|
|
25
|
+
metadata?: IOperationMetadata[];
|
|
26
|
+
initData?: string | null;
|
|
27
|
+
lastOperationId?: string;
|
|
28
|
+
sessionCreatedAt: Date | null;
|
|
29
|
+
}
|
|
30
|
+
interface ICollaborativeEditingConnectResponseData {
|
|
31
|
+
buffers: Buffer[] | Uint8Array[];
|
|
32
|
+
types: number[];
|
|
33
|
+
baseVersion: number;
|
|
34
|
+
lastOperationId?: string;
|
|
35
|
+
sessionCreatedAt: Date | null;
|
|
36
|
+
}
|
|
37
|
+
export default class CollaborativeEditingConnectResponse extends Message {
|
|
38
|
+
readonly channel: string;
|
|
39
|
+
readonly version: number;
|
|
40
|
+
readonly buffers: Buffer[] | Uint8Array[];
|
|
41
|
+
readonly types: number[];
|
|
42
|
+
readonly offset: number;
|
|
43
|
+
readonly metadata: IOperationMetadata[];
|
|
44
|
+
readonly initData: string | null;
|
|
45
|
+
readonly sessionId: string;
|
|
46
|
+
readonly lastOperationId: string;
|
|
47
|
+
readonly sessionCreatedAt: Date | null;
|
|
48
|
+
static readonly DESCRIPTOR_NAME: string;
|
|
49
|
+
static readonly DESCRIPTOR: IDescriptorBody;
|
|
50
|
+
/**
|
|
51
|
+
* @deprecated - Use CollaborativeEditingConnectResponse.create factory method instead.
|
|
52
|
+
*
|
|
53
|
+
* @param channel - Name of channel on which messages will be published.
|
|
54
|
+
* @param version - Version of the document.
|
|
55
|
+
* @param buffers - List of operations compressed to the binary format.
|
|
56
|
+
* @param types - List of compressor identifiers.
|
|
57
|
+
* @param offset - Number of changes in previous editing sessions.
|
|
58
|
+
* @param metadata - Metadata of changes.
|
|
59
|
+
* @param initData - Initialization data of the document.
|
|
60
|
+
*/
|
|
61
|
+
constructor(channel: string, version: number, buffers?: Buffer[] | Uint8Array[], types?: number[], offset?: number, metadata?: IOperationMetadata[], initData?: string | null, sessionId?: string, lastOperationId?: string, sessionCreatedAt?: Date | null);
|
|
62
|
+
get data(): ICollaborativeEditingConnectResponseData;
|
|
63
|
+
get wereChangesApplied(): boolean;
|
|
64
|
+
toJSON(): ICollaborativeEditingConnectResponse;
|
|
65
|
+
static create(params: ICollaborativeEditingConnectResponseParams): CollaborativeEditingConnectResponse;
|
|
66
|
+
static fromJSON(data: ICollaborativeEditingConnectResponse): CollaborativeEditingConnectResponse;
|
|
67
|
+
}
|
|
68
|
+
export {};
|
|
@@ -20,4 +20,4 @@
|
|
|
20
20
|
*
|
|
21
21
|
*
|
|
22
22
|
*/
|
|
23
|
-
'use strict';var __importDefault=this&&this['__importDefault']||function(
|
|
23
|
+
'use strict';var __importDefault=this&&this['__importDefault']||function(_0xddd4eb){return _0xddd4eb&&_0xddd4eb['__esModule']?_0xddd4eb:{'default':_0xddd4eb};};Object['defineProperty'](exports,'__esModule',{'value':!0x0});const message_1=__importDefault(require('./../../message')),operationmetadatahelpers_1=__importDefault(require('./../helpers/operationmetadatahelpers')),operationmetadatadescriptor_1=__importDefault(require('../descriptors/operationmetadatadescriptor'));class CollaborativeEditingConnectResponse extends message_1['default']{constructor(_0xc51b09,_0x3ab6f8,_0x54e051=[],_0x210a1f=[],_0x3560ac=0x0,_0x1350f4=[],_0x42e975=null,_0x34890d='',_0x4a9d84='',_0x2d8eb2=null){super(),this['channel']=_0xc51b09,this['version']=_0x3ab6f8,this['buffers']=_0x54e051,this['types']=_0x210a1f,this['offset']=_0x3560ac,this['metadata']=_0x1350f4,this['initData']=_0x42e975,this['sessionId']=_0x34890d,this['lastOperationId']=_0x4a9d84,this['sessionCreatedAt']=_0x2d8eb2;}get['data'](){return{'buffers':this['buffers'],'types':this['types'],'baseVersion':this['version']-this['types']['length'],'lastOperationId':this['lastOperationId'],'sessionCreatedAt':this['sessionCreatedAt']};}get['wereChangesApplied'](){var _0x470faf;return!(null===(_0x470faf=this['types'])||void 0x0===_0x470faf?void 0x0:_0x470faf['length'])&&null===this['initData'];}['toJSON'](){var _0x238487;return{'channel':this['channel'],'version':this['version'],'sessionId':this['sessionId'],'buffers':this['buffers'],'types':this['types'],'offset':this['offset'],'metadata':operationmetadatahelpers_1['default']['removeUnnecessaryMetadata'](this['types'],this['metadata'])['map'](operationmetadatadescriptor_1['default']['toJSON']),'initData':null!==(_0x238487=this['initData'])&&void 0x0!==_0x238487?_0x238487:'','isInitialized':'string'==typeof this['initData'],'lastOperationId':this['lastOperationId'],'sessionCreatedAt':this['sessionCreatedAt']?this['sessionCreatedAt']['toISOString']():null};}static['create'](_0x41cca9){return new CollaborativeEditingConnectResponse(_0x41cca9['channel'],_0x41cca9['version'],_0x41cca9['buffers'],_0x41cca9['types'],_0x41cca9['offset'],_0x41cca9['metadata'],_0x41cca9['initData'],_0x41cca9['sessionId'],_0x41cca9['lastOperationId'],_0x41cca9['sessionCreatedAt']);}static['fromJSON'](_0x15f0ef){var _0x4a58f0;let _0x584949=null;return!0x0===_0x15f0ef['isInitialized']?_0x584949=null!==(_0x4a58f0=_0x15f0ef['initData'])&&void 0x0!==_0x4a58f0?_0x4a58f0:'':'boolean'!=typeof _0x15f0ef['isInitialized']&&_0x15f0ef['initData']&&(_0x584949=_0x15f0ef['initData']),CollaborativeEditingConnectResponse['create']({'channel':_0x15f0ef['channel'],'version':_0x15f0ef['version'],'buffers':_0x15f0ef['buffers'],'types':_0x15f0ef['types'],'offset':_0x15f0ef['offset'],'metadata':operationmetadatahelpers_1['default']['prepareMetadataForOperations'](_0x15f0ef['types'],_0x15f0ef['metadata'])['map'](operationmetadatadescriptor_1['default']['fromJSON']),'initData':_0x584949,'sessionId':_0x15f0ef['sessionId'],'lastOperationId':_0x15f0ef['lastOperationId'],'sessionCreatedAt':_0x15f0ef['sessionCreatedAt']?new Date(_0x15f0ef['sessionCreatedAt']):null});}}exports['default']=CollaborativeEditingConnectResponse,CollaborativeEditingConnectResponse['DESCRIPTOR_NAME']='CollaborativeEditingConnectResponse',CollaborativeEditingConnectResponse['DESCRIPTOR']={'fields':{'channel':{'type':'string','id':0x1},'offset':{'type':'uint32','id':0x2},'version':{'type':'uint32','id':0x3},'buffers':{'rule':'repeated','type':'bytes','id':0x4},'types':{'rule':'repeated','type':'uint32','id':0x5},'metadata':{'rule':'repeated','type':operationmetadatadescriptor_1['default']['DESCRIPTOR_NAME'],'id':0x7},'initData':{'type':'string','id':0x8},'isInitialized':{'type':'bool','id':0x9},'sessionId':{'type':'string','id':0xa},'lastOperationId':{'type':'string','id':0xb},'sessionCreatedAt':{'type':'string','id':0xc}}};
|